codabase 0.3.0

Polyglot development tool for markdown-defined data types.
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

//! Command-line argument parsing and handling.
use std::{
    io::{BufReader, Read},
    path::PathBuf,
};

use clap::{Parser, Subcommand, ValueEnum};

pub mod compile;
pub mod cryptography;
pub mod inspect;

/// Command-line arguments for the `codabase` terminal interface.
#[derive(Parser, Debug)]
#[command(version, about, long_about = None)]
pub struct Args {
    /// Command to execute.
    #[command(subcommand)]
    command: Command,
}

impl Args {
    /// Execute the subcommand in these arguments.
    pub fn execute(self) {
        match self.command {
            Command::Compile(cmd) => compile::execute_compile_command(cmd),
            Command::Inspect(cmd) => inspect::execute_inspect_command(cmd),
            Command::Crypt(cmd) => {
                cryptography::execute_cryptography_command(cmd);
            }
        }
    }
}

/// Subcommand passed to [Args].
#[derive(Subcommand, Debug, Clone)]
#[command()]
pub enum Command {
    /// Compile language-specific bindings for codas.
    Compile(CompileCommand),

    /// Inspect binary coda-encoded data.
    Inspect(InspectCommand),

    /// Cryptography-related utilities.
    #[command(subcommand)]
    Crypt(CryptographyCommand),
}

/// Arguments passed to [Command::Compile].
#[derive(clap::Args, Debug, Clone)]
pub struct CompileCommand {
    /// Path to a coda markdown file, or a directory
    /// of coda files.
    ///
    /// If unspecified, coda markdown will be read
    /// from standard input.
    #[arg(short, long)]
    source: Option<PathBuf>,

    /// Output directory for compiled files.
    ///
    /// Only used in batch mode (when `--lang` is not set).
    #[arg(short, long, default_value_os_t = get_working_directory().join("target"))]
    target: PathBuf,

    /// Target language to compile to.
    ///
    /// When set, compiles a single coda and writes the
    /// output to standard output. When unset, compiles
    /// all codas in `--source` to all languages in `--target`.
    #[arg(short, long)]
    lang: Option<Lang>,
}

/// Supported target languages for code generation.
#[derive(ValueEnum, Debug, Clone, Copy)]
pub enum Lang {
    Rust,
    Python,
    Typescript,
    OpenApi,
    Duckdb,
    Sqlite,
}

/// Arguments passed to [Command::Inspect].
#[derive(clap::Args, Debug, Clone)]
pub struct InspectCommand {
    /// Path to a file containing coda-encoded data.
    ///
    /// If unspecified, data will be read from standard input.
    #[arg(short, long)]
    source: Option<PathBuf>,
}

/// Subcommand passed to [Command::Crypt].
#[derive(Subcommand, Debug, Clone)]
#[command()]
pub enum CryptographyCommand {
    /// Hash data into a [codas::types::cryptography::HashBytes].
    Hash {
        /// Path to a file containing data to hash.
        ///
        /// If unspecified, data will be read from standard input.
        #[arg(short, long)]
        source: Option<PathBuf>,
    },

    /// Generate a cryptographic keypair for signing data.
    Keygen {
        /// Passphrase to encrypt the generated keypair with.
        #[arg(short, long)]
        passphrase: String,
    },

    /// Sign data into a [codas::types::cryptography::SignatureBytes].
    Sign {
        /// Path to a file containing the signing keypair to use.
        #[arg(short, long)]
        keypair: PathBuf,

        /// Passphrase to decrypt the signing keypair with.
        #[arg(short, long)]
        passphrase: String,

        /// Path to a file containing data to sign.
        ///
        /// If unspecified, data will be read from standard input.
        #[arg(short, long)]
        source: Option<PathBuf>,
    },
}

/// Returns the working directory of the current executable.
fn get_working_directory() -> PathBuf {
    std::env::current_dir().unwrap()
}

/// Opens the contents of the file at `path` for reading.
///
/// Iff `path` is `None`, the contents of standard
/// input will be opened for reading until there is
/// no more input.
fn open_file_or_stdin(path: Option<PathBuf>) -> std::io::Result<Box<dyn Read>> {
    match path {
        Some(path) => Ok(Box::new(BufReader::new(std::fs::File::open(path)?))),
        None => Ok(Box::new(BufReader::new(std::io::stdin()))),
    }
}