Initial closure-tree crate scaffolding

Author: seuros

.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      CLOSURE_TREE_TEST_DATABASE_URL: postgres://closure_tree:closure_tree_pass@localhost:5432/closure_tree_test
+    services:
+      postgres:
+        image: postgres:17
+        env:
+          POSTGRES_USER: closure_tree
+          POSTGRES_PASSWORD: closure_tree_pass
+          POSTGRES_DB: closure_tree_test
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd="pg_isready -U postgres"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=5
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy,rustfmt
+
+      - name: Check formatting
+        run: cargo fmt --all -- --check
+
+      - name: Lint
+        run: cargo clippy --all-targets -- -D warnings
+
+      - name: Run tests
+        run: cargo test

Cargo.toml

@@ -0,0 +1,36 @@
+[package]
+name = "closure-tree"
+version = "0.0.1"
+edition = "2021"
+description = "Closure Tree support for SeaORM (PostgreSQL)."
+readme = "README.md"
+license = "MIT"
+repository = "https://github.com/ClosureTree/closure-tree-rs"
+homepage = "https://github.com/ClosureTree/closure-tree-rs"
+keywords = ["sea-orm", "hierarchy", "tree", "postgres", "closure-tree"]
+categories = ["database", "data-structures"]
+
+[dependencies]
+sea-orm = { version = "1.1", default-features = false, features = [
+    "macros",
+    "runtime-tokio-rustls",
+    "sqlx-postgres",
+    "mock",
+] }
+sqlx = { version = "0.8", default-features = false, features = [
+    "runtime-tokio-rustls",
+    "postgres",
+] }
+async-trait = "0.1"
+thiserror = "2"
+once_cell = "1"
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
+crc32fast = "1"
+closure-tree-macros = { version = "0.0.1", path = "closure-tree-macros" }
+
+[dev-dependencies]
+tokio = { version = "1.47", features = ["rt-multi-thread", "macros"] }
+
+[patch.crates-io]
+closure-tree-macros = { path = "closure-tree-macros" }

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ClosureTree
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,65 @@
+# closure-tree (Rust)
+
+A SeaORM-friendly port of Ruby's [`closure_tree`](https://github.com/ClosureTree/closure_tree).
+
+## Status
+
+Early preview (`0.0.1`). PostgreSQL only. Contributions welcome.
+
+## Quickstart
+
+```toml
+[dependencies]
+closure-tree = "0.0.1"
+```
+
+```rust
+use closure_tree::ClosureTreeRepository;
+use closure_tree::ClosureTreeModelDerive as ClosureTreeModel;
+use sea_orm::entity::prelude::*;
+
+#[derive(Clone, Debug, PartialEq, DeriveEntityModel, ClosureTreeModel)]
+#[sea_orm(table_name = "nodes")]
+#[closure_tree(hierarchy_module = "crate::entity::node_hierarchy", hierarchy_table = "node_hierarchies")]
+pub struct Model {
+    #[sea_orm(primary_key)]
+    pub id: i32,
+    pub parent_id: Option<i32>,
+    pub name: String,
+}
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let db = sea_orm::Database::connect("postgres://...").await?;
+    let repo = ClosureTreeRepository::<entity::node::Model>::new();
+
+    let _leaf = repo
+        .find_or_create_by_path(&db, &["root", "child", "leaf"])
+        .await?;
+
+    Ok(())
+}
+```
+
+## Features
+
+* Derive macro for SeaORM models (`#[derive(ClosureTreeModel)]`).
+* Repository helpers (`parent`, `descendants`, `find_by_path`, `find_or_create_by_path`, etc.).
+* Advisory locks via `pg_advisory_lock`, rebuild utilities.
+* Integration test against a Docker Postgres instance.
+
+## Limitations
+
+* PostgreSQL only.
+* Ordering, `hash_tree`, dependent strategies, and some Ruby APIs are not yet ported.
+* Advisory lock is limited to Postgres advisory locks; no MySQL adapter yet.
+
+## Development
+
+```
+cargo fmt
+cargo clippy --all-targets -- -D warnings
+cargo test
+```
+
+Requires Docker Postgres at `postgres://closure_tree:closure_tree_pass@localhost:5434/closure_tree_test` (see `tests/postgres.rs`).

closure-tree-macros/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "closure-tree-macros"
+version = "0.0.1"
+edition = "2021"
+description = "Procedural macros for closure-tree."
+readme = "../README.md"
+license = "MIT"
+repository = "https://github.com/ClosureTree/closure-tree-rs"
+homepage = "https://github.com/ClosureTree/closure-tree-rs"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+proc-macro2 = "1"
+quote = "1"
+syn = { version = "2", features = ["full"] }