gcli 1.10.0

Gear program CLI
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

// This file is part of Gear.
//
// Copyright (C) 2021-2025 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! Gear program template

use crate::result::Result;
use anyhow::anyhow;
use etc::{Etc, FileSystem, Read, Write};
use reqwest::Client;
use std::{env, process::Command};

const GITHUB_TOKEN: &str = "GITHUB_TOKEN";

/// see https://docs.github.com/en/rest/repos/repos
const GEAR_DAPPS_GH_API: &str = "https://api.github.com/orgs/gear-foundation/repos";
const GEAR_DAPP_ORG: &str = "https://github.com/gear-foundation/";

/// Repo object from github api response.
#[derive(serde::Deserialize)]
struct Repo {
    pub name: String,
}

/// List all examples.
pub async fn list() -> Result<Vec<String>> {
    let mut rb = Client::builder()
        .user_agent("gcli")
        .build()
        .map_err(|e| anyhow!("Failed to build http client: {}", e))?
        .get(GEAR_DAPPS_GH_API);

    if let Ok(tk) = env::var(GITHUB_TOKEN) {
        rb = rb.bearer_auth(tk);
    }

    let resp = rb
        .send()
        .await
        .map_err(|e| anyhow!("Failed to get examples: {}", e))?;

    let repos = resp
        .json::<Vec<Repo>>()
        .await
        .map_err(|e| anyhow!("Failed to deserialize example list: {}", e))?
        .into_iter()
        .map(|repo| repo.name)
        .collect();

    Ok(repos)
}

/// Download example
pub async fn download(example: &str, path: &str) -> Result<()> {
    let url = format!("{GEAR_DAPP_ORG}{example}.git");
    Command::new("git")
        .args(["clone", &url, path, "--depth=1"])
        .status()
        .map_err(|e| anyhow!("Failed to download example: {e}"))?;

    let repo = Etc::new(path)?;
    repo.rm(".git")?;

    // Init new git repo.
    Command::new("git")
        .args(["init", path])
        .status()
        .map_err(|e| anyhow!("Failed to init git: {e}"))?;

    // Find all manifests
    let mut manifests = Vec::new();
    repo.find_all("Cargo.toml", &mut manifests)?;

    // Update each manifest
    for manifest in manifests {
        let manifest = Etc::new(manifest)?;
        let mut toml = String::from_utf8_lossy(
            &manifest
                .read()
                .map_err(|_| anyhow!("Failed to read Cargo.toml"))?,
        )
        .to_string();

        process_manifest(&mut toml)?;
        manifest.write(toml.as_bytes())?;
    }

    Ok(())
}

/// Update project manifest.
fn process_manifest(manifest: &mut String) -> Result<()> {
    let (user, email) = {
        let user_bytes = Command::new("git")
            .args(["config", "--global", "--get", "user.name"])
            .output()?
            .stdout;
        let user = String::from_utf8_lossy(&user_bytes);

        let email_bytes = Command::new("git")
            .args(["config", "--global", "--get", "user.email"])
            .output()?
            .stdout;
        let email = String::from_utf8_lossy(&email_bytes);

        (user.to_string(), email.to_string())
    };

    *manifest = manifest.replace(
        r#"authors = ["Gear Technologies"]"#,
        &format!("authors = [\"{} <{}>\"]", user.trim(), email.trim()),
    );

    Ok(())
}

#[tokio::test]
async fn list_examples() {
    let ls = list().await.expect("Failed to get examples");
    // TODO: #2914
    assert!(
        ls.contains(&"dapp-template".to_string()),
        "all templates: {ls:?}"
    );
}