scarb 0.5.2

The Cairo package manager
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

use std::collections::HashMap;
use std::sync::atomic::{AtomicU64, Ordering};

use assert_fs::fixture::ChildPath;
use assert_fs::prelude::*;
use camino::Utf8PathBuf;
use semver::Version;
use toml_edit::{Document, Item, Table, Value};

use to_version::ToVersion;

use crate::support::fsx::PathUtf8Ext;
use crate::support::gitx::GitProject;

#[path = "../../../src/internal/to_version.rs"]
mod to_version;

pub struct ProjectBuilder {
    name: String,
    version: Version,
    cairo_version: Option<Version>,
    src: HashMap<Utf8PathBuf, String>,
    deps: Vec<(String, Value)>,
    manifest_extra: String,
}

impl ProjectBuilder {
    pub fn start() -> Self {
        // Nondeterministic counter forces users to fix fields that are present in assertions.
        static COUNTER: AtomicU64 = AtomicU64::new(0);

        let n = COUNTER.fetch_add(0, Ordering::Relaxed);
        Self {
            name: format!("pkg{n}"),
            version: Version::new(1, n, 0),
            cairo_version: None,
            src: HashMap::from_iter([(
                Utf8PathBuf::from("src/lib.cairo"),
                format!(r#"fn f{n}() -> felt252 {{ {n} }}"#),
            )]),
            deps: Vec::new(),
            manifest_extra: String::new(),
        }
    }

    pub fn name(mut self, name: impl Into<String>) -> Self {
        self.name = name.into();
        self
    }

    pub fn version(mut self, version: impl ToVersion) -> Self {
        self.version = version.to_version().unwrap();
        self
    }

    pub fn cairo_version(mut self, cairo_version: impl ToVersion) -> Self {
        self.cairo_version = Some(cairo_version.to_version().unwrap());
        self
    }

    pub fn src(mut self, path: impl Into<Utf8PathBuf>, source: impl Into<String>) -> Self {
        self.src.insert(path.into(), source.into());
        self
    }

    pub fn lib_cairo(self, source: impl Into<String>) -> Self {
        self.src("src/lib.cairo", source.into())
    }

    pub fn dep(mut self, name: impl Into<String>, dep: impl ToDep) -> Self {
        self.deps.push((name.into(), dep.to_dep()));
        self
    }

    pub fn dep_starknet(self) -> Self {
        self.dep("starknet", r#"version = ">=2.0.0-rc0""#)
    }

    pub fn manifest_extra(mut self, extra: impl Into<String>) -> Self {
        self.manifest_extra = extra.into();
        self
    }

    pub fn just_manifest(&self, t: &impl PathChild) {
        let mut doc = Document::new();
        doc["package"]["name"] = Item::Value(Value::from(self.name.clone()));
        doc["package"]["version"] = Item::Value(Value::from(self.version.to_string()));
        if let Some(cairo_version) = self.cairo_version.as_ref() {
            doc["package"]["cairo-version"] = Item::Value(Value::from(cairo_version.to_string()));
        }
        for (name, dep) in &self.deps {
            doc["dependencies"][name.clone()] = Item::Value(dep.clone());
        }

        let mut manifest = doc.to_string();

        if !self.manifest_extra.is_empty() {
            manifest.push('\n');
            manifest.push_str(&self.manifest_extra);
        }

        t.child("Scarb.toml").write_str(&manifest).unwrap();
    }

    pub fn just_code(&self, t: &impl PathChild) {
        for (path, source) in &self.src {
            t.child(path).write_str(source).unwrap();
        }
    }

    pub fn build(&self, t: &impl PathChild) {
        self.just_manifest(t);
        self.just_code(t);
    }
}

pub trait ToDep {
    fn to_dep(&self) -> Value;
}

impl ToDep for Table {
    fn to_dep(&self) -> Value {
        self.clone().into_inline_table().into()
    }
}

impl ToDep for &str {
    fn to_dep(&self) -> Value {
        let doc = self.parse::<Document>().unwrap();
        let tab = doc.as_table().clone().into_inline_table();
        Value::InlineTable(tab)
    }
}

impl ToDep for String {
    fn to_dep(&self) -> Value {
        self.as_str().to_dep()
    }
}

impl ToDep for &ChildPath {
    fn to_dep(&self) -> Value {
        let mut table = toml_edit::table();
        table["path"] = Item::Value(Value::from(self.path().try_to_utf8().unwrap().to_string()));
        table.into_value().unwrap()
    }
}

impl ToDep for &GitProject {
    fn to_dep(&self) -> Value {
        let mut table = toml_edit::table();
        table["git"] = Item::Value(Value::from(self.url()));
        table.into_value().unwrap()
    }
}