shelly-data 0.1.0

Data-layer primitives for Shelly LiveView (schemas, changesets, repo, migrations).
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
use crate::{
    adapter::{AdapterKind, DatabaseConfig},
    error::{DataError, DataResult},
    query::{FilterOperator, Query, SortDirection},
};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::{cmp::Ordering, collections::BTreeMap};

pub type Row = BTreeMap<String, Value>;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct StoredRow {
    pub id: u64,
    pub data: Row,
}

pub trait AdapterDriver: Send + Sync {
    fn kind(&self) -> AdapterKind;
}

#[derive(Debug, Default, Clone, Copy)]
pub struct PostgresAdapter;

impl AdapterDriver for PostgresAdapter {
    fn kind(&self) -> AdapterKind {
        AdapterKind::Postgres
    }
}

#[derive(Debug, Default, Clone, Copy)]
pub struct MySqlAdapter;

impl AdapterDriver for MySqlAdapter {
    fn kind(&self) -> AdapterKind {
        AdapterKind::MySql
    }
}

#[derive(Debug, Default, Clone, Copy)]
pub struct SqliteAdapter;

impl AdapterDriver for SqliteAdapter {
    fn kind(&self) -> AdapterKind {
        AdapterKind::Sqlite
    }
}

pub fn adapter_for(config: &DatabaseConfig) -> DataResult<Box<dyn AdapterDriver>> {
    match config.adapter {
        AdapterKind::Postgres => Ok(Box::new(PostgresAdapter)),
        AdapterKind::MySql => Ok(Box::new(MySqlAdapter)),
        AdapterKind::Sqlite => Ok(Box::new(SqliteAdapter)),
        AdapterKind::None => Err(DataError::Adapter(
            "database adapter is `none`; select postgres/mysql/sqlite in shelly.data.toml"
                .to_string(),
        )),
    }
}

pub trait Repo {
    fn adapter_kind(&self) -> AdapterKind;
    fn insert(&mut self, table: &str, data: Row) -> DataResult<StoredRow>;
    fn update(&mut self, table: &str, id: u64, data: Row) -> DataResult<StoredRow>;
    fn delete(&mut self, table: &str, id: u64) -> DataResult<()>;
    fn find(&self, table: &str, id: u64) -> DataResult<Option<StoredRow>>;
    fn list(&self, table: &str, query: &Query) -> DataResult<Vec<StoredRow>>;
}

pub struct MemoryRepo {
    driver: Box<dyn AdapterDriver>,
    tables: BTreeMap<String, Vec<StoredRow>>,
    next_id: u64,
}

impl MemoryRepo {
    pub fn new(driver: Box<dyn AdapterDriver>) -> Self {
        Self {
            driver,
            tables: BTreeMap::new(),
            next_id: 1,
        }
    }
}

impl Repo for MemoryRepo {
    fn adapter_kind(&self) -> AdapterKind {
        self.driver.kind()
    }

    fn insert(&mut self, table: &str, data: Row) -> DataResult<StoredRow> {
        let entry = self.tables.entry(table.to_string()).or_default();
        let row = StoredRow {
            id: self.next_id,
            data,
        };
        self.next_id += 1;
        entry.push(row.clone());
        Ok(row)
    }

    fn update(&mut self, table: &str, id: u64, data: Row) -> DataResult<StoredRow> {
        let rows = self.tables.entry(table.to_string()).or_default();
        let Some(existing) = rows.iter_mut().find(|row| row.id == id) else {
            return Err(DataError::Query(format!(
                "row id {id} not found in table `{table}`"
            )));
        };
        existing.data = data;
        Ok(existing.clone())
    }

    fn delete(&mut self, table: &str, id: u64) -> DataResult<()> {
        let rows = self.tables.entry(table.to_string()).or_default();
        let initial_len = rows.len();
        rows.retain(|row| row.id != id);
        if rows.len() == initial_len {
            return Err(DataError::Query(format!(
                "row id {id} not found in table `{table}`"
            )));
        }
        Ok(())
    }

    fn find(&self, table: &str, id: u64) -> DataResult<Option<StoredRow>> {
        Ok(self
            .tables
            .get(table)
            .and_then(|rows| rows.iter().find(|row| row.id == id))
            .cloned())
    }

    fn list(&self, table: &str, query: &Query) -> DataResult<Vec<StoredRow>> {
        let mut rows = self.tables.get(table).cloned().unwrap_or_default();

        if !query.filters.is_empty() {
            rows.retain(|row| {
                query
                    .filters
                    .iter()
                    .all(|filter| matches_filter(row, filter))
            });
        }

        for sort in query.sorts.iter().rev() {
            rows.sort_by(|left, right| compare_for_sort(left, right, sort.field.as_str()));
            if sort.direction == SortDirection::Desc {
                rows.reverse();
            }
        }

        if let Some(pagination) = query.pagination {
            let offset = (pagination.page.saturating_sub(1)) * pagination.per_page;
            rows = rows
                .into_iter()
                .skip(offset)
                .take(pagination.per_page)
                .collect();
        }

        Ok(rows)
    }
}

fn matches_filter(row: &StoredRow, filter: &crate::query::Filter) -> bool {
    let Some(candidate) = row.data.get(&filter.field) else {
        return false;
    };
    match filter.op {
        FilterOperator::Eq => candidate == &filter.value,
        FilterOperator::Neq => candidate != &filter.value,
        FilterOperator::Contains => candidate
            .as_str()
            .zip(filter.value.as_str())
            .is_some_and(|(left, right)| left.contains(right)),
        FilterOperator::Gt => {
            compare_numbers(candidate, &filter.value).is_some_and(|ord| ord == Ordering::Greater)
        }
        FilterOperator::Gte => compare_numbers(candidate, &filter.value)
            .is_some_and(|ord| ord == Ordering::Greater || ord == Ordering::Equal),
        FilterOperator::Lt => {
            compare_numbers(candidate, &filter.value).is_some_and(|ord| ord == Ordering::Less)
        }
        FilterOperator::Lte => compare_numbers(candidate, &filter.value)
            .is_some_and(|ord| ord == Ordering::Less || ord == Ordering::Equal),
    }
}

fn compare_for_sort(left: &StoredRow, right: &StoredRow, field: &str) -> Ordering {
    let left_value = left.data.get(field);
    let right_value = right.data.get(field);
    match (left_value, right_value) {
        (Some(Value::Number(left_num)), Some(Value::Number(right_num))) => left_num
            .as_f64()
            .partial_cmp(&right_num.as_f64())
            .unwrap_or(Ordering::Equal),
        (Some(Value::String(left_text)), Some(Value::String(right_text))) => {
            left_text.cmp(right_text)
        }
        _ => left.id.cmp(&right.id),
    }
}

fn compare_numbers(left: &Value, right: &Value) -> Option<Ordering> {
    left.as_f64()
        .zip(right.as_f64())
        .and_then(|(left, right)| left.partial_cmp(&right))
}

#[cfg(test)]
mod tests {
    use super::{adapter_for, DatabaseConfig, MemoryRepo, Repo, Row};
    use crate::{AdapterKind, DataError, Filter, FilterOperator, Query, SortDirection};
    use serde_json::json;

    #[test]
    fn memory_repo_works_for_adapter_selection() {
        let mut repo = MemoryRepo::new(
            adapter_for(&DatabaseConfig {
                adapter: AdapterKind::Sqlite,
                url: None,
                url_env: None,
            })
            .unwrap(),
        );
        let mut row = Row::new();
        row.insert("title".to_string(), json!("Alpha"));
        row.insert("score".to_string(), json!(10));
        repo.insert("posts", row).unwrap();

        let rows = repo
            .list(
                "posts",
                &Query::new()
                    .where_filter(Filter::contains("title", "Al"))
                    .order_by("score", SortDirection::Desc),
            )
            .unwrap();
        assert_eq!(rows.len(), 1);
        assert_eq!(rows[0].data.get("title"), Some(&json!("Alpha")));
    }

    #[test]
    fn adapter_for_rejects_none_and_selects_expected_driver() {
        let none_result = adapter_for(&DatabaseConfig {
            adapter: AdapterKind::None,
            url: None,
            url_env: None,
        });
        assert!(matches!(none_result, Err(DataError::Adapter(_))));

        for kind in [
            AdapterKind::Postgres,
            AdapterKind::MySql,
            AdapterKind::Sqlite,
        ] {
            let driver = adapter_for(&DatabaseConfig {
                adapter: kind,
                url: None,
                url_env: None,
            })
            .expect("driver should be created");
            assert_eq!(driver.kind(), kind);
        }
    }

    #[test]
    fn update_delete_and_find_cover_missing_rows() {
        let mut repo = MemoryRepo::new(Box::new(super::SqliteAdapter));

        let mut row = Row::new();
        row.insert("title".to_string(), json!("Draft"));
        let inserted = repo.insert("posts", row).expect("insert should work");

        assert_eq!(
            repo.find("posts", inserted.id)
                .expect("find should not fail")
                .map(|it| it.id),
            Some(inserted.id)
        );
        assert!(repo
            .find("posts", 999)
            .expect("find should not fail")
            .is_none());
        assert!(repo
            .find("missing_table", inserted.id)
            .expect("find should not fail")
            .is_none());

        let mut updated = Row::new();
        updated.insert("title".to_string(), json!("Published"));
        let updated_row = repo
            .update("posts", inserted.id, updated)
            .expect("update should work");
        assert_eq!(updated_row.data.get("title"), Some(&json!("Published")));

        let update_err = repo
            .update("posts", 404, Row::new())
            .expect_err("missing row should fail update");
        assert!(matches!(update_err, DataError::Query(_)));

        repo.delete("posts", inserted.id)
            .expect("delete should remove row");
        let delete_err = repo
            .delete("posts", inserted.id)
            .expect_err("deleting missing row should fail");
        assert!(matches!(delete_err, DataError::Query(_)));
    }

    #[test]
    fn list_applies_filters_sorts_and_pagination() {
        let mut repo = MemoryRepo::new(Box::new(super::SqliteAdapter));

        let mut alpha = Row::new();
        alpha.insert("title".to_string(), json!("Alpha"));
        alpha.insert("score".to_string(), json!(10));
        alpha.insert("tag".to_string(), json!("core"));
        repo.insert("posts", alpha).expect("insert alpha");

        let mut beta = Row::new();
        beta.insert("title".to_string(), json!("Beta"));
        beta.insert("score".to_string(), json!(20));
        beta.insert("tag".to_string(), json!("ops"));
        repo.insert("posts", beta).expect("insert beta");

        let mut gamma = Row::new();
        gamma.insert("title".to_string(), json!("Gamma"));
        gamma.insert("score".to_string(), json!(15));
        gamma.insert("tag".to_string(), json!(123));
        repo.insert("posts", gamma).expect("insert gamma");

        let eq_rows = repo
            .list(
                "posts",
                &Query::new().where_filter(Filter::eq("title", json!("Alpha"))),
            )
            .expect("eq filter");
        assert_eq!(eq_rows.len(), 1);
        assert_eq!(eq_rows[0].data.get("title"), Some(&json!("Alpha")));

        let neq_rows = repo
            .list(
                "posts",
                &Query::new().where_filter(crate::Filter {
                    field: "title".to_string(),
                    op: FilterOperator::Neq,
                    value: json!("Alpha"),
                }),
            )
            .expect("neq filter");
        assert_eq!(neq_rows.len(), 2);

        let contains_rows = repo
            .list(
                "posts",
                &Query::new().where_filter(Filter::contains("title", "mm")),
            )
            .expect("contains filter");
        assert_eq!(contains_rows.len(), 1);
        assert_eq!(contains_rows[0].data.get("title"), Some(&json!("Gamma")));

        let contains_non_string_rows = repo
            .list(
                "posts",
                &Query::new().where_filter(Filter::contains("tag", "2")),
            )
            .expect("contains on mixed type");
        assert!(contains_non_string_rows.is_empty());

        for (op, expected_titles) in [
            (FilterOperator::Gt, vec!["Beta"]),
            (FilterOperator::Gte, vec!["Beta", "Gamma"]),
            (FilterOperator::Lt, vec!["Alpha"]),
            (FilterOperator::Lte, vec!["Alpha", "Gamma"]),
        ] {
            let rows = repo
                .list(
                    "posts",
                    &Query::new().where_filter(crate::Filter {
                        field: "score".to_string(),
                        op,
                        value: json!(15),
                    }),
                )
                .expect("numeric filter");
            let titles: Vec<&str> = rows
                .iter()
                .map(|row| {
                    row.data
                        .get("title")
                        .and_then(|value| value.as_str())
                        .expect("title")
                })
                .collect();
            assert_eq!(titles, expected_titles);
        }

        let unknown_field_sort = repo
            .list(
                "posts",
                &Query::new()
                    .order_by("missing", SortDirection::Desc)
                    .paginate(1, 2),
            )
            .expect("fallback sort");
        assert_eq!(unknown_field_sort.len(), 2);
        assert_eq!(unknown_field_sort[0].id, 3);
        assert_eq!(unknown_field_sort[1].id, 2);

        let score_sort = repo
            .list(
                "posts",
                &Query::new()
                    .order_by("score", SortDirection::Desc)
                    .order_by("title", SortDirection::Asc),
            )
            .expect("score sort");
        let score_titles: Vec<&str> = score_sort
            .iter()
            .map(|row| {
                row.data
                    .get("title")
                    .and_then(|value| value.as_str())
                    .expect("title")
            })
            .collect();
        assert_eq!(score_titles, vec!["Beta", "Gamma", "Alpha"]);
    }
}