accrete 0.0.9__tar.gz → 0.0.11__tar.gz

{accrete-0.0.9 → accrete-0.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: accrete
-Version: 0.0.9
+Version: 0.0.11
 Summary: Django Shared Schema Multi Tenant
 Author-email: Benedikt Jilek <benedikt.jilek@pm.me>
 License: Copyright (c) 2023 Benedikt Jilek

{accrete-0.0.9 → accrete-0.0.11}/accrete/contrib/ui/__init__.py

@@ -1,4 +1,3 @@
-from . import config
 from .filter import Filter
 from .helper import (
     ClientAction,
@@ -6,7 +5,7 @@ from .helper import (
     FormContext,
     ListContext,
     BreadCrumb,
+    TableField,
     build_querystring,
-    parse_client_actions,
     queryset_from_querystring
 )

{accrete-0.0.9 → accrete-0.0.11}/accrete/contrib/ui/helper.py

@@ -8,11 +8,10 @@ from django.utils.translation import gettext_lazy as _
 from django.core.exceptions import FieldDoesNotExist
 from django.core.paginator import Paginator
 from accrete.contrib.ui.filter import Filter
-from . import config
 
 _logger = logging.getLogger(__name__)
 
-ACTIONS_TEMPLATE = config.ACCRETE_UI_ACTIONS_TEMPLATE
+DEFAULT_PAGINATE_BY = 40
 
 
 @dataclass
@@ -25,18 +24,6 @@ class ClientAction:
     submit: bool = False
     form_id: str = 'form'
     class_list: list = field(default_factory=list)
-    mobile: bool = True
-    tablet: bool = True
-
-
-def parse_client_actions(actions: list[ClientAction], actions_template: str = None):
-    tablet = (not all(action.tablet for action in actions))
-    mobile = (not all(action.mobile for action in actions))
-    return {
-        'actions_template': actions_template or ACTIONS_TEMPLATE,
-        'actions': actions,
-        'action_button': {'mobile': mobile, 'tablet': tablet}
-    }
 
 
 @dataclass
@@ -46,6 +33,13 @@ class BreadCrumb:
     url: str
 
 
+@dataclass
+class TableField:
+
+    label: str
+    name: str
+
+
 @dataclass
 class ListContext:
 
@@ -57,12 +51,14 @@ class ListContext:
     extra_query: Q = None
     related_fields: list[str] = field(default_factory=list)
     prefetch_fields: list[str] = field(default_factory=list)
-    paginate_by: int = 20
+    paginate_by: int = DEFAULT_PAGINATE_BY
     order_by: list[str] = None
     column_width: int = 12
     filter_relation_depth: int = 4
     actions: list[ClientAction] = field(default_factory=list)
     breadcrumbs: list[BreadCrumb] = field(default_factory=list)
+    obj_label: str = None
+    fields: list[TableField] = field(default_factory=list)
 
     def get_queryset(self):
         order = self.get_order()
@@ -116,10 +112,11 @@ class ListContext:
             'filter_terms': Filter(self.model, self.filter_relation_depth).get_query_terms(),
             'view_type': 'list',
             'breadcrumbs': self.breadcrumbs,
-            'querystring': build_querystring(self.get_params)
+            'querystring': build_querystring(self.get_params),
+            'actions': self.actions,
+            'obj_label': self.obj_label or _('Name'),
+            'fields': self.fields
         }
-        if self.actions:
-            context.update(parse_client_actions(self.actions))
         context.update(self.context)
         return context
 
@@ -130,14 +127,15 @@ class DetailContext:
     obj: Model
     get_params: dict
     order_by: str = None
-    paginate_by: int = 20
+    paginate_by: int = DEFAULT_PAGINATE_BY
     title: str = None
     queryset: type[QuerySet] = None
     extra_query: Q = None
     related_fields: list[str] = field(default_factory=list)
     prefetch_fields: list[str] = field(default_factory=list)
     actions: list[ClientAction] = field(default_factory=list)
-    breadcrumbs: list[BreadCrumb] = field(default_factory=list)
+    breadcrumbs: list[BreadCrumb] = field(default_factory=list),
+    context: dict = field(default_factory=dict)
 
     def get_queryset(self):
         order = self.get_order()
@@ -197,25 +195,26 @@ class DetailContext:
             'detail_pagination': False,
             'view_type': 'detail',
             'breadcrumbs': self.breadcrumbs,
-            'querystring': build_querystring(self.get_params, ['page'])
+            'querystring': build_querystring(self.get_params, ['page']),
+            'actions': self.actions
         }
         if self.paginate_by > 0:
             ctx.update(self.get_pagination_context())
-        if self.actions:
-            ctx.update(parse_client_actions(self.actions))
+        ctx.update(self.context)
         return ctx
 
 
 @dataclass
 class FormContext:
 
-    model: Model|type[Model]
+    model: Model | type[Model]
     get_params: dict
     title: str = None
     context: dict = field(default_factory=dict)
     form_id: str = 'form'
     add_default_actions: bool = True
     discard_url: str = None
+    actions: list[ClientAction] = field(default_factory=list)
 
     def get_default_form_actions(self):
         actions = [
@@ -228,12 +227,11 @@ class FormContext:
         ]
         try:
             url = self.discard_url or self.model.get_absolute_url()
-        except TypeError as e:
-            _logger.exception(
+        except TypeError:
+            raise TypeError(
                 'Supply the discard_url parameter if FormContext is called '
                 'with a model class instead of an instance.'
             )
-            raise e
         except AttributeError as e:
             _logger.error(
                 'Supply the discard_url parameter if FormContext is '
@@ -264,10 +262,12 @@ class FormContext:
             'title': self.get_title(),
             'view_type': 'form',
             'form_id': self.form_id,
-            'querystring': build_querystring(self.get_params, ['page'])
+            'querystring': build_querystring(self.get_params, ['page']),
+            'actions': []
         }
         if self.add_default_actions:
-            ctx.update(parse_client_actions(self.get_default_form_actions()))
+            ctx.update({'actions': self.get_default_form_actions()})
+        ctx['actions'].extend(self.actions)
         ctx.update(self.context)
         return ctx
 
@@ -276,6 +276,8 @@ def build_querystring(get_params: dict, extra_params: list[str] = None) -> str:
     querystring = f'?q={get_params.get("q", "[]")}'
     if paginate_by := get_params.get('paginate_by', False):
         querystring += f'&paginate_by={paginate_by}'
+    # if page := get_params.get('page', False):
+    #     querystring += f'&page={page}'
     if order_by := get_params.get('order_by', False):
         querystring += f'&order_by={order_by}'
     for param in extra_params or []:

{accrete-0.0.9 → accrete-0.0.11}/accrete/contrib/ui/static/css/accrete.css

@@ -1,32 +1,9 @@
-.header-sticky {
-    position: sticky;
-    top: 0;
-    background: white;
-}
-
-table {
-    margin-bottom: 12px !important;
-}
-
-th {
-    background-color: white;
-}
-
-/*tbody > tr:hover {*/
-/*    background-color: #f5f5f5;*/
-/*}*/
-
-label {
-    word-break: break-word;
-}
-
-.dropdown-link:hover {
-    cursor: pointer;
-    background-color: #f5f5f5;
+.columns {
+    margin: 0;
 }
 
-.link-row:hover {
-    cursor: pointer;
+.columns:last-child {
+    margin-bottom: 0;
 }
 
 .main-columns {
@@ -34,34 +11,16 @@ label {
     height: 100vh;
 }
 
-.side-panel {
-    height: 100%;
-    padding: 0 4px 0 0;
-    border-radius: 0;
-    position: sticky;
-    top: 0;
-}
-
-.side-panel > .panel {
-    border-radius: 0;
-    height: 100%;
-    overflow-y: auto;
-    position: sticky;
-    top: 0;
-}
-
-.info-panel {
-    padding: 4px;
-    border-radius: 0;
+.column {
+    padding: 0;
 }
 
-.info-panel > .panel {
-    border-radius: 0;
-    box-shadow: 0 0 0 0
+.breadcrumb * a {
+    color: #0a0a0a;
 }
 
-.title {
-    word-break: break-all;
+.table td, .table th {
+    padding: .2rem .75rem .2rem 0;
 }
 
 td > a {
@@ -69,15 +28,7 @@ td > a {
     width:100%;
 }
 
-.notification {
-    word-wrap: break-word
-}
-
-.list-link {
-    color: #48c78e;
-}
-
-a:link:not(.list-link) {
+a {
     color: #0a0a0a;
 }
 
@@ -85,39 +36,10 @@ a:visited {
     color: #0a0a0a;
 }
 
-.content-column {
-    height: 100%;
-    overflow-y: auto;
-}
-
-.content-column > table > thead th {
-    position: sticky;
-    top: 0;
-}
-
-.buttons > .panel-block {
-    padding: .5rem 0 .5rem .5rem;
-}
-
-.level-item > .panel-block {
-    padding-left: 2px;
-    padding-right: 2px;
-}
-
-.level-item > .panel-block:first-child {
-    padding-left: 0;
-}
-
-.panel-block:not(:last-child) {
+.side-panel * .panel-block:not(:last-child) {
     border-bottom: none !important;
 }
 
-.container > .level {
-    margin: 0;
-    max-width: 100%;
-    overflow-x: hidden;
-}
-
 .level * {
     max-width: 100%;
 }
@@ -126,10 +48,6 @@ a:visited {
     word-break: break-all;
 }
 
-.columns {
-    margin: 0;
-}
-
 input:focus {
     outline: 1px solid #48c78e !important;
     border: 1px solid #48c78e !important;
@@ -218,8 +136,22 @@ select:focus {
     margin-bottom: 0;
 }
 
-.level-is-shrinkable .level-left,
-.level-is-shrinkable .level-item,
-.level-is-shrinkable .level-right {
-  flex-shrink: 1;
-}
+.label.has-field {
+    height: 100%;
+    display: flex;
+    flex-direction: column;
+    justify-content: end;
+    font-weight: 300;
+    word-break: break-all;
+    padding: 12px 12px 12px 0;
+}
+
+.label.is-required {
+    font-weight: 700;
+}
+
+@media screen and (max-width: 768px) {
+    .label.has-field {
+        padding: 12px 0 12px 0;
+    }
+}

{accrete-0.0.9 → accrete-0.0.11}/accrete/contrib/ui/templates/ui/detail.html

@@ -5,7 +5,6 @@
     <div class="columns is-desktop">
         {% block messages %}{% endblock %}
         <div class="column p-0 is-8-desktop">
-            {% include 'ui/partials/header.html' %}
             <div>
                 {% block detail_content %}{% endblock %}
             </div>

{accrete-0.0.9 → accrete-0.0.11}/accrete/contrib/ui/templates/ui/form.html

@@ -4,7 +4,6 @@
 {% block content %}
     <div class="columns is-desktop">
         <div class="column p-0 is-8-desktop">
-            {% include 'ui/partials/header.html' %}
             <div>
                 {% include 'ui/partials/form_errors.html' with show_field_errors=True %}
                 {% block form %}{% endblock %}

accrete-0.0.11/accrete/contrib/ui/templates/ui/layout.html

@@ -0,0 +1,162 @@
+<!doctype html>
+{% load static %}
+{% load i18n %}
+{% load accrete_ui %}
+
+<html lang="en" style="overflow: hidden">
+
+<head>
+{% block head %}
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    {% block favicon %}<link rel="icon" type="image/svg" href="{% static 'icons/accrete.svg' %}"/>{% endblock %}
+    {% block bulma %}<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.4/css/bulma.min.css">{% endblock %}
+    {% block style %}
+        <link rel="stylesheet" type="text/css" href="{% static "css/accrete.css" %}">
+        <link rel="stylesheet" type="text/css" href="{% static "css/icons.css" %}">
+    {% endblock %}
+    {% block htmx %}
+        <script src="https://unpkg.com/htmx.org@1.9.6"></script>
+        <script src="https://unpkg.com/hyperscript.org@0.9.11"></script>
+    {% endblock %}
+    {% block script %}
+        <script src="{% static "js/navbar.js" %}" defer type="text/javascript"></script>
+        <script src="{% static "js/utils.js" %}" defer type="text/javascript"></script>
+    {% endblock %}
+    <title>{% block title %}{{ title }}{% endblock %}</title>
+{% endblock %}
+</head>
+
+
+<body {% block body_attrs %}hx-headers='{"X-CSRFToken": "{{ csrf_token }}"}'{% endblock %}>
+    {% block navbar %}
+        <nav id="navbar" class="navbar is-success is-fixed-top" role="navigation" aria-label="main navigation">
+            <div class="navbar-brand">
+                {% block navbar_brand %}
+                    <div class="navbar-item is-unselectable">{{ request.tenant.name }}</div>
+                {% endblock %}
+                <a id="navbar-burger" role="button" class="navbar-burger"
+                   aria-label="menu" aria-expanded="false"
+                   _="on click toggle .is-active on me then toggle .is-active on .navbar-menu"
+                >
+                    {# Display hamburger menu on mobile #}
+                    <span aria-hidden="true"></span>
+                    <span aria-hidden="true"></span>
+                    <span aria-hidden="true"></span>
+                </a>
+            </div>
+
+            <div class="navbar-menu is-fixed-top">
+                <div class="navbar-start">
+                    {% block navbar_start %}
+                        {% combine_templates 'accrete_menu.html' %}
+                    {% endblock %}
+                </div>
+
+                <div class="navbar-end">
+                    {% block navbar_end %}
+                    {% endblock %}
+                </div>
+            </div>
+        </nav>
+    {% endblock %}
+
+    <div class="main-columns columns m-0 is-mobile">
+        <div class="side-panel column is-3-widescreen is-2-fullhd is-hidden-touch is-hidden-desktop-only is-hidden-widescreen-only p-0" style="height: 100%; position: sticky; top: 0">
+            <nav class="panel is-shadowless pb-5" style="height: 100%; overflow-y: auto; position: sticky; top: 0">
+                {% if list_pagination %}
+                    <div class="panel-block pb-0">
+                        {% include 'ui/partials/pagination_list.html' %}
+                    </div>
+                {% endif %}
+                {% if detail_pagination %}
+                    <div class="panel-block pb-0">
+                        {% include 'ui/partials/pagination_detail.html' %}
+                    </div>
+                {% endif %}
+                <div id="panel-actions">
+                    {% for action in actions %}
+                        <div class="panel-block pb-0">
+                            {% if action.submit %}
+                                <input class="button is-fullwidth {{ action.class_list|join:' ' }}"
+                                       type="submit" form={{ action.form_id }} value="{{ action.name }}"
+                                       {% for attr in action.attrs %}{{ attr }}{% endfor %}
+                                >
+                            {% else %}
+                                <a class="button is-fullwidth {{ action.class_list|join:' ' }}"
+                                   href="{{ action.url }}{{ querystring|default_if_none:'?' }}{% if page %}&page={{ page.number }}{% endif %}{{ action.query_params }}"
+                                   {% for attr in action.attrs %}{{ attr }}{% endfor %}
+                                >{{ action.name }}
+                                </a>
+                            {% endif %}
+                        </div>
+                    {% endfor %}
+                </div>
+                {% if filter_terms %}
+                    <div id="filter-panel" class="mt-2">
+                        <div class="panel-list px-3 has-text-centered">
+                            <span>{% translate 'Filter' %}</span>
+                        </div>
+                        <div class="panel-block" style="position: sticky">
+                            <button id="reset-filter-button"
+                                    class="button is-fullwidth mr-1">{% translate 'Reset' %}
+                            </button>
+                            <button id="apply-filter-button"
+                                    class="button is-fullwidth ml-1">{% translate 'Filter' %}
+                            </button>
+                        </div>
+                        {% include 'ui/partials/filter.html' %}
+                    </div>
+                {% endif %}
+            </nav>
+        </div>
+
+        <div class="column" style="overflow-x: auto">
+            <div class="is-flex is-flex-direction-column" style="height: 100%; overflow: hidden">
+                <div>
+                    {% include 'ui/partials/header.html' %}
+                </div>
+                <div id="content" class="px-3 pb-4" style="overflow: auto; flex-grow: 1">
+                    {% block messages %}{% endblock %}
+                    {% block content %}{% endblock %}
+                </div>
+                <div>
+                    {% if list_pagination or detail_pagination %}
+                        <div class="level is-hidden-tablet is-align-self-flex-start m-3">
+                            <div class="level-item is-align-content-flex-start">
+                                {% if list_pagination %}
+                                    {% include 'ui/partials/pagination_list.html' %}
+                                {% elif detail_pagination %}
+                                    {% include 'ui/partials/pagination_detail.html' %}
+                                {% endif %}
+                            </div>
+                        </div>
+                    {% endif %}
+                </div>
+            </div>
+        </div>
+    </div>
+
+    {% if filter_terms %}
+        <div id="filter-modal" class="modal">
+            <div class="modal-background filter-modal-close"></div>
+            <div class="modal-card" style="height: 100%">
+                <header class="modal-card-head">
+                    <p class="modal-card-title">
+                        {% block search_modal_title %}{% translate 'Filter' %}{% endblock %}</p>
+                    <button class="delete filter-modal-close" aria-label="close"></button>
+                </header>
+                <section id="modal-content" class="modal-card-body">
+                </section>
+                <footer class="modal-card-foot">
+                    <button class="button is-fullwidth mr-1"
+                            onclick="resetFilter()">{% translate 'Reset' %}</button>
+                    <button id="applyFilterFromModalButton"
+                            class="button is-fullwidth is-success ml-1">{% translate 'Filter' %}</button>
+                </footer>
+            </div>
+        </div>
+    {% endif %}
+
+    <div id="form-modal" class="modal"></div>
+</body>

accrete-0.0.11/accrete/contrib/ui/templates/ui/list.html

@@ -0,0 +1,22 @@
+{% extends 'ui/layout.html' %}
+{% load static %}
+{% load i18n %}
+
+{% block script %}
+    {{ block.super }}
+    <script src="{% static "js/filter.js" %}" defer type="text/javascript"></script>
+{% endblock %}
+
+{% block content %}
+    <div class="columns is-multiline">
+        {% for obj in page %}
+            <div class="column is-{{ column_width }}">
+                <div class="box p-2 pb-4 mb-1" style="word-break: break-word; height: 100%; border: solid #ccc 1px">
+                    {% block object_data %}
+                        {{ obj }}
+                    {% endblock %}
+                </div>
+            </div>
+        {% endfor %}
+    </div>
+{% endblock %}

accrete-0.0.11/accrete/contrib/ui/templates/ui/partials/header.html

@@ -0,0 +1,53 @@
+{% load i18n %}
+
+<div class="pt-3">
+    <div class="level level-is-shrinkable is-flex mb-2 pl-3 {% if detail_pagination %}is-mobile {% endif %}">
+        <div class="level-left">
+            <div class="level-item has-text-weight-bold">
+                <nav class="breadcrumb" aria-label="breadcrumbs" style="white-space: unset; word-break: break-word">
+                    <ul>
+                        {% for crumb in breadcrumbs %}
+                            <li><a class="is-underlined" href="{{ crumb.url|default_if_none:'#' }}{{ querystring }}" aria-current="page">{{ crumb.name }}</a></li>
+                        {% endfor %}
+                        <li class="is-active"><a aria-current="page">{{ title }}</a></li>
+                    </ul>
+                </nav>
+            </div>
+        </div>
+        {% if list_pagination or detail_pagination %}
+            <div class="level-right is-mobile is-hidden-mobile is-hidden-fullhd is-align-self-flex-start px-3">
+                <div class="level-item">
+                    {% if list_pagination %}
+                        {% include 'ui/partials/pagination_list.html' %}
+                    {% elif detail_pagination %}
+                        {% include 'ui/partials/pagination_detail.html' %}
+                    {% endif %}
+                </div>
+            </div>
+        {% endif %}
+    </div>
+
+    <div class="is-flex is-hidden-fullhd is-justify-content-space-between mb-2">
+        <div class="is-flex py-1 px-1 ml-2" style="overflow-x: auto">
+            {% for action in actions %}
+                {% if action.submit %}
+                    <input class="button mr-2 {{ action.class_list|join:' ' }}"
+                           type="submit" form={{ action.form_id }} value="{{ action.name }}"
+                           {% for attr in action.attrs %}{{ attr }}{% endfor %}
+                    >
+                {% else %}
+                    <a class="button mr-2 {{ action.class_list|join:' ' }}"
+                       href="{{ action.url }}{{ querystring|default_if_none:'?' }}{% if page %}&page={{ page.number }}{% endif %}{{ action.query_params }}"
+                       {% for attr in action.attrs %}{{ attr }}{% endfor %}
+                    >{{ action.name }}
+                    </a>
+                {% endif %}
+            {% endfor %}
+        </div>
+        {% if filter_terms %}
+            <div class="is-flex ml-2 py-1 pr-3">
+                <button id="modal-filter-button" class="button">Filter</button>
+            </div>
+        {% endif %}
+    </div>
+</div>

accrete-0.0.11/accrete/contrib/ui/templates/ui/partials/pagination_detail.html

@@ -0,0 +1,23 @@
+<div id="detail-pagination" class="field has-addons" style="width: 100%">
+    <p class="control">
+        <button class="button"
+                hx-get="{{ previous_object_url }}{{ querystring }}"
+                hx-replace-url="true"
+                hx-select-oob="#content,#detail-pagination,#panel-actions"
+        ><
+        </button>
+
+    </p>
+    <p class="control is-expanded">
+        <button class="button is-fullwidth px-1" style="white-space: normal">
+            <span class="{% if total_objects > 99999 %}is-size-7{% endif %}">{{ current_object_idx }} / {{ total_objects }}</span>
+        </button>
+    </p>
+    <p class="control">
+        <button class="button" hx-get="{{ next_object_url }}{{ querystring }}"
+                hx-replace-url="true"
+                hx-select-oob="#content,#detail-pagination,#panel-actions"
+        >>
+        </button>
+    </p>
+</div>

{accrete-0.0.9 → accrete-0.0.11}/accrete/contrib/ui/templates/ui/partials/pagination_list.html

@@ -4,25 +4,23 @@
         <button class="button"
                 hx-get="{{ querystring }}&page={% if page.has_previous %}{{ page.previous_page_number }}{% else %}{{ paginator.num_pages }}{% endif %}"
                 hx-replace-url="true"
-                hx-select-oob="#content,#list-pagination"
+                hx-select-oob="#content,#list-pagination,#panel-actions"
         >
             <
         </button>
     </p>
     <p class="control is-expanded">
-        {% if paginator.count > 9999 %}
-            <button class="button is-fullwidth px-0">
-                <span class="is-size-7">{{ page.start_index }}-{{ page.end_index }}<br>/{{ paginator.count }}</span>
-            </button>
-        {% else %}
-            <button class="button is-fullwidth">{{ page.start_index }}-{{ page.end_index }}/{{ paginator.count }}</button>
-        {% endif %}
+        <button class="button is-fullwidth px-1" style="white-space: normal">
+            <span class="{% if paginator.count > 9999 %}is-size-7{% endif %}">
+                {{ page.start_index }}-{{ page.end_index }} / {{ paginator.count }}
+            </span>
+        </button>
     </p>
     <p class="control">
         <button class="button"
                 hx-get="{{ querystring }}&page={% if page.has_next %}{{ page.next_page_number }}{% else %}1{% endif %}"
                 hx-replace-url="true"
-                hx-select-oob="#content,#list-pagination"
+                hx-select-oob="#content,#list-pagination,#panel-actions"
         >
             >
         </button>