rocksgraph 0.1.0

A Gremlin-inspired property graph query engine written in Rust, backed by RocksDB
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

set allow-duplicate-recipes := true
set allow-duplicate-variables := true
set shell := ["bash", "-euo", "pipefail", "-c"]

# ---------------------------------------------------------------------------- #
#                                 DEPENDENCIES                                 #
# ---------------------------------------------------------------------------- #

# Rust: https://rust-lang.org/tools/install
cargo := require("cargo")
rustc := require("rustc")

# ---------------------------------------------------------------------------- #
#                                    RECIPES                                   #
# ---------------------------------------------------------------------------- #

# Show available commands
default:
    @just --list

# Build the program
build:
    cargo build

# Build the program for release
build-release:
    cargo build --release
alias br := build-release

# Check the program for errors without building
check:
    cargo check

# Run the program
run:
    cargo run

# Generate documentation
doc:
    cargo doc --open

# Run all code checks
full-check:
    cargo fmt --all --check
    cargo clippy -- --deny warnings
alias fc := full-check

full-write:
    cargo fmt --all
alias fw := full-write

# Run tests
test:
    cargo test

# Run tests and open an HTML code coverage report in the browser
coverage:
    cargo llvm-cov --open

# Run tests and print a code coverage summary to the terminal
coverage-summary:
    cargo llvm-cov

# Audit dependencies for RUSTSEC advisories, license conflicts, and banned/duplicate
# crates (requires `cargo install cargo-deny`)
audit:
    cargo deny check
alias au := audit

# Cut a release: verifies the tree is clean, full-check/test/audit/dry-run all pass,
# and CHANGELOG.md has an entry — then tags, pushes the tag, and runs `cargo publish`.
# Bump the version in Cargo.toml and add the CHANGELOG.md entry yourself first.
release:
    #!/usr/bin/env bash
    set -euo pipefail
    version=$(grep -m1 '^version = ' Cargo.toml | sed -E 's/version = "(.*)"/\1/')
    echo "Preparing to release v$version"

    if [ -n "$(git status --porcelain)" ]; then
        echo "Working tree is not clean — commit or stash changes first." >&2
        exit 1
    fi

    if ! grep -q "## \[$version\]" CHANGELOG.md; then
        echo "CHANGELOG.md has no entry for $version — add one first." >&2
        exit 1
    fi

    just full-check
    just test
    just audit
    cargo publish --dry-run

    read -r -p "About to tag v$version, push tags, and run 'cargo publish'. Continue? [y/N] " confirm
    if [ "$confirm" != "y" ] && [ "$confirm" != "Y" ]; then
        echo "Aborted."
        exit 1
    fi

    git tag "v$version"
    git push --tags
    cargo publish