lariv-rs 0.1.0

Compile-time plugin web application framework built on Axum, SeaORM, Maud, and HTMX
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! Excel spreadsheet (XLSX) creation and table export.
//!
//! Maps database metadata catalogs, tracks model relationship graphs,
//! and downloads filtered table records as XLSX workbooks.
//!
//! # Templates
//!
//! - [`templates::ExportPage`] — main export panel with table selector sidebar.
//!
//! # Routes
//!
//! - `/export/` — table selection screen ([`handlers::page`]).
//! - `/export/download/` — POST download of selected models ([`handlers::download`]).

pub mod apps;
pub mod handlers;
pub mod routes;
pub mod state;
pub mod templates;
pub mod xlsx;

use frunk::{HCons, hlist::HList};

use crate::plugin_install::define_plugin_install;
use crate::{
    app::App,
    capability::{CapStore, define_passthrough_cap},
    db::{DbCap, DbTag},
    hooks::AttachState,
    traits::{
        add::{AddCapability, CapTagAbsent},
        get::GetByCapTag,
    },
};

use state::ExportState;

/// Plugin identity tag for export routes/templates/state.
pub struct ExportPluginTag;

define_passthrough_cap!(ExportStateCap, ExportPluginTag, ExportState);

define_plugin_install! {
    plugin: ExportPluginTag;
    steps: [
        apps(apps::Hook),
        templates(templates::Hook),
        slots(templates::SlotsHook),
        http(routes::Hook),
        state(StateHook),
    ]
}

/// Attaches [`ExportState`] (DB connection) at app mount.
#[derive(Clone, Copy, Default)]
pub struct StateHook;

impl<L, DbIdx, TagProof> AttachState<L, (DbIdx, TagProof)> for StateHook
where
    L: GetByCapTag<DbTag, DbIdx, Value = DbCap>,
    L: HList + CapTagAbsent<ExportPluginTag, TagProof>,
{
    type Output = HCons<ExportStateCap, L>;

    fn attach_state(app: App<L>) -> App<Self::Output> {
        let conn = app.get_capability::<DbTag, DbIdx>().items.conn.clone();
        app.add_capability(CapStore::with_items(ExportState::new(conn)))
    }
}