rustfava 0.1.0__py3-none-any.whl

rustfava/template_filters.py

@@ -0,0 +1,64 @@
+"""Template filters for Fava.
+
+All functions in this module will be automatically added as template filters.
+"""
+
+from __future__ import annotations
+
+from decimal import Decimal
+from pathlib import Path
+from re import sub
+from typing import TYPE_CHECKING
+from unicodedata import normalize
+
+from rustfava.context import g
+
+if TYPE_CHECKING:  # pragma: no cover
+    from typing import TypeVar
+
+    from rustfava.beans.abc import Meta
+    from rustfava.beans.abc import MetaValue
+
+    T = TypeVar("T")
+
+
+ZERO = Decimal()
+
+
+def meta_items(meta: Meta | None) -> list[tuple[str, MetaValue]]:
+    """Remove keys from a dictionary."""
+    if not meta:  # pragma: no cover
+        return []
+    return [
+        (key, value)
+        for key, value in meta.items()
+        if not (key in {"filename", "lineno"} or key.startswith("__"))
+    ]
+
+
+def replace_numbers(value: T) -> str | None:
+    """Replace numbers, to be used in incognito mode."""
+    return sub(r"[0-9]", "X", str(value)) if value is not None else None
+
+
+def passthrough_numbers(value: T) -> T:
+    """Pass through value unchanged."""
+    return value
+
+
+def format_currency(value: Decimal, currency: str | None = None) -> str:
+    """Format a value using the derived precision for a specified currency."""
+    return g.ledger.format_decimal(value or ZERO, currency)
+
+
+FLAGS_TO_TYPES = {"*": "cleared", "!": "pending"}
+
+
+def flag_to_type(flag: str) -> str:
+    """Names for entry flags."""
+    return FLAGS_TO_TYPES.get(flag, "other")
+
+
+def basename(file_path: str) -> str:
+    """Return the basename of a filepath."""
+    return normalize("NFC", Path(file_path).name)

rustfava/templates/_journal_table.html

@@ -0,0 +1,156 @@
+{% from 'macros/_commodity_macros.html' import render_num, render_amount %}
+
+{% set short_type = {
+   'balance': 'Bal',
+   'close': 'Close',
+   'document': 'Doc',
+   'note': 'Note',
+   'open': 'Open',
+} %}
+
+{# Normalize rustledger type names (e.g., 'rltransaction' -> 'transaction') #}
+{% macro _normalize_type(raw_type) %}
+{%- if raw_type.startswith('rl') -%}
+{{ raw_type[2:] }}
+{%- else -%}
+{{ raw_type }}
+{%- endif -%}
+{% endmacro %}
+
+{% macro _account_link(name) %}<a href='{{ url_for('account', name=name) }}'>{{ name }}</a>{% endmacro %}
+
+{% macro _render_metadata_indicators(metadata) -%}
+{% for key, value in metadata %}
+<span class='metadata-indicator' title='{{ key }}: {{ value }}'>{{ key[:2] }}</span>
+{% endfor %}
+{%- endmacro %}
+
+{% macro _render_metadata(metadata, entry_hash=None) -%}
+{% if metadata %}
+<dl class='metadata'>
+  {% for key, value in metadata %}
+  <dt>{{ key }}:</dt>
+  <dd>
+  {%- if key.startswith('document') %}<a class='filename' data-remote target=_blank href='{{ url_for('statement', entry_hash=entry_hash, key=key) }}'>{{ value }}</a>
+  {% elif value is string and (value.startswith('http://') or value.startswith('https://')) %}<a class='url' data-remote target=_blank rel='noopener noreferrer' href='{{ value }}'>{{ value }}</a>
+  {% else %}
+    {{ value }}
+  {% endif -%}
+  </dd>
+  {% endfor %}
+</dl>
+{% endif %}
+{% endmacro %}
+
+{% macro _render_tags_links(entry) -%}
+{% for tag in entry.tags|sort %}<span class='tag'>#{{ tag }}</span>{% endfor %}
+{% for link_ in entry.links|sort %}<span class='link'>^{{ link_ }}</span>{% endfor %}
+{%- endmacro %}
+
+{% macro journal_table_contents(entries, show_change_and_balance=False, ledger=None) %}
+{% set ledger = ledger or g.ledger %}
+{% autoescape false %}
+{% for entry in entries %}
+    {% if show_change_and_balance %}
+        {% set index, entry, change, balance = entry %}
+    {% else %}
+        {% set index, entry = entry %}
+    {% endif %}
+    {% set raw_type = entry.__class__.__name__.lower() %}
+    {% set type = _normalize_type(raw_type)|trim %}
+    {% set metadata_items = entry.meta|meta_items %}
+    {% set entry_hash = entry|hash_entry -%}
+    <li class='{{ type }} {{ entry.type or '' }} {{ entry.flag|flag_to_type if entry.flag else '' }}{{ ' linked' if entry.tags and 'linked' in entry.tags else '' }}{{ ' discovered' if entry.tags and 'discovered' in entry.tags else '' }}'>
+        <p>
+        <span class='datecell' data-sort-value='{{ index }}'><a href='#context-{{ entry_hash }}'>{{ entry.date }}</a></span>
+        <span class='flag'>{% if type == 'transaction' %}{{ entry.flag }}{% else %}{{ short_type.get(type, type[:3]) }}{% endif %}</span>
+        <span class='description'>
+        {% if type == 'open' or type == 'close' %}
+            {{ _account_link(entry.account) }}
+        {% elif type == 'note' %}
+            {{ entry.comment }}
+        {% elif type == 'query' %}
+          <a href='{{ url_for('report', report_name='query', query_string='run "{}"'.format(entry.name)) }}'>{{ entry.name }}</a>
+        {% elif type == 'pad' %}
+            {{ _account_link(entry.account) }}&nbsp;from&nbsp;{{ _account_link(entry.source_account) }}
+        {% elif type == 'custom' %}
+          <strong>{{ entry.type }}</strong>
+          {%- for value in entry['values'] -%}
+            &nbsp;{% if value.dtype|string == "<AccountDummy>" %}{{ _account_link(value.value) }}
+            {%- elif value.dtype|string == "<class 'beancount.core.amount.Amount'>" %}{{ render_amount(ledger, value.value) }}
+            {%- elif value.dtype|string == "<class 'str'>" %}"{{ value.value }}"
+            {%- elif value.dtype|string == "<class 'bool'>" %}{{ value.value }}
+            {%- elif value.dtype|string == "<class 'datetime.date'>" %}{{ value.value }}{% endif -%}
+          {%- endfor -%}
+        {% elif type == 'document' %}
+            {{ _account_link(entry.account) }}
+            <a class='filename' data-remote target=_blank href='{{ url_for('document', filename=entry.filename) }}'>{{ entry.filename|basename }}</a>
+            {{ _render_tags_links(entry) }}
+        {% elif type == 'balance' %}
+            {{ _account_link(entry.account) }}
+            {% if entry.diff_amount %}
+            <span class='spacer'></span>
+            accumulated <span class='num'>{{ (entry.amount.number + entry.diff_amount.number)|format_currency(entry.amount.currency) }} {{ entry.amount.currency }}</span>
+            {% endif %}
+        {% elif type == 'transaction' %}
+            <strong class='payee'>{{ entry.payee or '' }}</strong>{% if entry.payee and entry.narration %}<span class='separator'></span>{% endif %}{{ entry.narration or '' }}
+            {{ _render_tags_links(entry) }}
+        {% endif %}
+        </span>
+        <span class='indicators'>
+          {{- _render_metadata_indicators(metadata_items) -}}
+          {%- for posting in entry.postings -%}
+          <span{% if posting.flag %} class='{{ posting.flag|flag_to_type }}'{% endif %}></span>
+          {{- _render_metadata_indicators(posting.meta|meta_items) -}}
+          {%- endfor -%}
+        </span>
+        {% if type == 'balance' %}
+          {{ render_amount(ledger, entry.amount, 'num bal' + (' pending' if entry.diff_amount else '')) }}
+            {% if entry.diff_amount %}
+              <span class='change num bal pending'>
+              {{- render_num(ledger, entry.diff_amount.currency, entry.diff_amount.number) -}}
+              </span>
+            {% else %}
+              <span class='change num'></span>
+            {% endif %}
+            {% if not show_change_and_balance %}
+              <span class='change num'></span>
+            {% endif %}
+        {% endif %}
+        {% if show_change_and_balance %}
+          {% if type == 'transaction' %}
+            <span class='change num'>
+            {%- for currency, number in change.items() %}{{ render_num(ledger, currency, number) }}<br>{% endfor -%}
+            </span>
+          {% endif %}
+          <span class='num'>
+          {%- for currency, number in balance.items() %}{{ render_num(ledger, currency, number) }}<br>{% endfor -%}
+          </span>
+        {% endif %}
+        </p>
+        {{ _render_metadata(metadata_items, entry_hash) }}
+        {% if entry.postings %}
+          <ul class='postings'>
+        {% for posting in entry.postings %}
+        <li{% if posting.flag %} class='{{ posting.flag|flag_to_type }}'{% endif %}>
+            <p>
+                <span class='datecell'></span>
+                <span class='flag'>{{ posting.flag or '' }}</span>
+                <span class='description'>{{ _account_link(posting.account) }}</span>
+                {# We want the output these amounts with the same precision as in the input file.
+                   For computed values this might give a lot of digits, so format the price using the DisplayContext for now.#}
+                <span class='num'>{% if posting.units %}{{ posting.units.number|incognito }} {{ posting.units.currency }}{% endif %}</span>
+                <span class='num'>{{ posting.cost.number|incognito }} {{ posting.cost.currency }}
+                    {{- ', {}'.format(posting.cost.date) if posting.cost.date else '' }}
+                    {{- ', "{}"'.format(posting.cost.label) if posting.cost.label else '' }}</span>
+                {{ render_amount(ledger, posting.price) }}
+            </p>
+            {{ _render_metadata(posting.meta|meta_items) }}
+        </li>
+        {% endfor %}
+        </ul>
+        {% endif %}
+    </li>
+{%- endfor %}
+{% endautoescape %}
+{%- endmacro %}

rustfava/templates/_layout.html

@@ -0,0 +1,26 @@
+{% set partial = request.args.get('partial') %}
+{% if not partial %}
+<!doctype html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link rel="shortcut icon" href="{{ static_url('favicon.ico') }}">
+    <link rel="stylesheet" href="{{ static_url('app.css') }}">
+    <title>{{ page_title or "" }} - {{ ledger.options.title }}</title>
+    <script type="module" src="{{ static_url('app.js') }}"></script>
+  </head>
+  <body>
+    <!-- <header> and <aside> get inserted here -->
+    <article>
+      {%- endif %}
+      {% block content %}{{ content }}{% endblock %}
+      {% if page_title %}<script type="application/json" id="page-title">{{ page_title|tojson }}</script>{% endif %}
+      {% if partial %}<script type="application/json" id="ledger-mtime">{{ ledger.mtime|tojson }}</script>{% endif %}
+      {%- if not partial %}
+    </article>
+    <script type="application/json" id="ledger-data">{{ get_ledger_data()|tojson }}</script>
+    <script type="application/json" id="ledger-mtime">{{ ledger.mtime|tojson }}</script>
+    <script type="application/json" id="translations">{{ translations()|tojson }}</script>
+  </body>
+</html>
+{%- endif %}

rustfava/templates/_query_table.html

@@ -0,0 +1,88 @@
+{% import 'macros/_account_macros.html' as account_macros %}
+{% import 'macros/_commodity_macros.html' as commodity_macros %}
+
+{% set sort_type = {
+    "<class 'decimal.Decimal'>": 'num',
+    "<class 'cdecimal.Decimal'>": 'num',
+    "<class 'int'>": 'num',
+    "<class 'beancount.core.amount.Amount'>": 'num',
+    "<class 'beancount.core.inventory.Inventory'>": 'num',
+    "<class 'beancount.core.position.Position'>": 'num',
+} %}
+
+{% macro querycell(ledger, name, value, type_) %}
+{% set type = type_|string %}
+{% if type == "<class 'beancount.core.inventory.Inventory'>" %}
+<td class="num">
+  {% for position in value|sort(attribute='units.currency') %}
+    {{ commodity_macros.render_amount(ledger, position.units) }}<br>
+  {% endfor %}
+</td>
+{% elif type == "<class 'str'>" %}
+<td>
+  {% if name == "account" %}
+    {{ account_macros.account_name(ledger, value) }}
+  {% elif name == "id" %}
+  <a href="#context-{{ value }}">{{ value }}</a>
+  {% else %}
+  {{ value }}
+  {% endif %}
+</td>
+{% elif type == "<class 'decimal.Decimal'>" or type == "<class 'cdecimal.Decimal'>" %}
+<td class="num" data-sort-value="{{ value or 0 }}">{{ value|format_currency }}</td>
+{% elif type == "<class 'beancount.core.amount.Amount'>" %}
+<td class="num" data-sort-value="{{ value.number or 0 }}">
+  {{ commodity_macros.render_amount(ledger, value) }}
+</td>
+{% elif type == "<class 'bool'>" %}
+<td>{{ value|upper }}</td>
+{% elif type == "<class 'int'>" %}
+<td class="num">{{ value }}</td>
+{% elif type == "<class 'set'>" %}
+<td>{{ value|join(',') }}</td>
+{% elif type == "<class 'datetime.date'>" %}
+<td>{{ value or '' }}</td>
+{% elif type == "<class 'beancount.core.position.Position'>" %}
+<td class="num">{{ commodity_macros.render_amount(ledger, value.units) }}</td>
+{% else %}
+<td class="query-error" title="Type {{ type|string }} not recognized">{{ value }}</td>
+{% endif %}
+{% endmacro %}
+
+{% macro querytable(ledger, contents, types, rows, filter_empty=None, footer=None) %}
+<p class="deprecation-notice">
+  The querytable macro is deprecated, please switch to the frontend-rendered query result.
+  See rustfava.ext.rustfava_ext_test for an example of how to use them.
+<p>
+{% if contents %}
+<pre><code>{{ contents }}</code></pre>
+{% elif types %}
+<table is="sortable-table" class="queryresults">
+  <thead>
+    <tr>
+      {% for name, type in types %}
+      <th data-sort="{{ sort_type[type|string] or "string" }}">{{ name }}</th>
+      {% endfor %}
+    </tr>
+  </thead>
+  <tbody>
+    {% for row in rows if filter_empty == None or not row[filter_empty].is_empty() %}
+    <tr>
+      {% for name, type in types %}
+      {{ querycell(ledger, name, row[name], type)  }}
+      {% endfor %}
+    </tr>
+    {% endfor %}
+  </tbody>
+  {% if footer %}
+  <tfoot>
+    <tr>
+      {% for type, value in footer %}
+        {{ querycell(ledger, '', value, type)  }}
+      {% endfor %}
+    </tr>
+  </tfoot>
+  {% endif %}
+</table>
+{% endif %}
+{% endmacro %}

rustfava/templates/beancount_file

@@ -0,0 +1,18 @@
+;; -*- mode: org; mode: beancount; -*-
+
+option "title" "{{ ledger.options.title }} - Journal Export"
+
+{% for currency in ledger.options.operating_currency -%}
+option "operating_currency" "{{ currency }}"
+{% endfor -%}
+
+option "name_assets" "{{ ledger.options.name_assets }}"
+option "name_liabilities" "{{ ledger.options.name_liabilities }}"
+option "name_equity" "{{ ledger.options.name_equity }}"
+option "name_income" "{{ ledger.options.name_income }}"
+option "name_expenses" "{{ ledger.options.name_expenses }}"
+plugin "beancount.plugins.auto_accounts"
+
+{% for rendered_entry in ledger.file.render_entries(g.filtered.entries) %}
+{{ rendered_entry|safe }}
+{% endfor %}

rustfava/templates/help.html

@@ -0,0 +1,23 @@
+{% extends "_layout.html" %}
+
+{% set page_title = _('Help') %}
+
+{% block content %}
+<div class="help">
+  <div class="help-sidebar">
+    <h3>{{ _('Help pages') }}</h3>
+    <ul>
+      {% for slug, title in HELP_PAGES|dictsort %}
+        <li>
+          <a href="{{ url_for('help_page', page_slug=slug) }}"{% if slug == page_slug %} class="selected"{% endif %}>
+            {{ title }}
+          </a>
+        </li>
+      {% endfor %}
+    </ul>
+  </div>
+  <div class="help-text">
+    {{ help_html }}
+  </div>
+</div>
+{% endblock %}

rustfava/templates/macros/_account_macros.html

@@ -0,0 +1,5 @@
+{% macro account_name(ledger, account_name) -%}
+<a href="{{ url_for('account', name=account_name) }}" class="account">
+  {{- account_name -}}
+</a>
+{%- endmacro %}

rustfava/templates/macros/_commodity_macros.html

@@ -0,0 +1,13 @@
+{% macro render_amount(ledger, amount, class="num") %}
+{% if amount is none or amount.number is none -%}
+  <span class='{{ class }}'></span>
+{%- else -%}
+  <span class='{{ class }}' title='{{ ledger.commodities.name(amount.currency) }}'>
+    {{- amount.number|format_currency(amount.currency)|incognito }} {{ amount.currency -}}
+  </span>
+{%- endif %}
+{% endmacro %}
+
+{% macro render_num(ledger, currency, number) -%}
+<span title='{{ ledger.commodities.name(currency) }}'>{{ number|format_currency(currency)|incognito }} {{ currency }}</span>
+{%- endmacro %}