lgtm-cli 0.3.0

Run LGTM code reviews with a bundled web UI and gRPC server.
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

use super::super::database::repositories::review_context as db;
use super::{ForgeRepositoryUrl, LocalLocation};
use crate::backend::error::{Result, invalid};
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "kind", rename_all = "snake_case", deny_unknown_fields)]
pub enum ContextKey {
    Local {
        location: LocalLocation,
    },
    ForgeBacked {
        repository_url: ForgeRepositoryUrl,
        number: i64,
    },
}

impl ContextKey {
    pub fn validate(&self) -> Result<()> {
        match self {
            Self::Local { location } => location.validate(),
            Self::ForgeBacked { number, .. } if *number < 1 => Err(invalid(
                "Forge-backed reviews require a positive PR/MR number",
            )),
            Self::ForgeBacked { .. } => Ok(()),
        }
    }

    pub fn is_forge_backed(&self) -> bool {
        matches!(self, Self::ForgeBacked { .. })
    }

    pub fn is_notes(&self) -> bool {
        matches!(
            self,
            Self::Local {
                location: LocalLocation::Notes { .. }
            }
        )
    }

    pub fn repository_url(&self) -> Option<&ForgeRepositoryUrl> {
        match self {
            Self::ForgeBacked { repository_url, .. } => Some(repository_url),
            Self::Local { .. } => None,
        }
    }

    pub fn git_dir(&self) -> Option<&str> {
        match self {
            Self::Local {
                location: LocalLocation::Branch { git_dir, .. },
            } => Some(git_dir),
            _ => None,
        }
    }

    pub fn label(&self) -> String {
        match self {
            Self::Local {
                location: LocalLocation::Notes { path },
            } => format!("notes:{path}"),
            Self::Local {
                location: LocalLocation::Branch { git_dir, branch },
            } => format!("{git_dir}@{}", branch.trim_start_matches("refs/heads/")),
            Self::ForgeBacked {
                repository_url,
                number,
            } => format!("{}#{number}", repository_url.as_str()),
        }
    }

    pub fn as_database_key(&self) -> db::ContextKey<'_> {
        match self {
            Self::Local {
                location: LocalLocation::Notes { path },
            } => db::ContextKey::Local(db::LocalLocation::Notes(path)),
            Self::Local {
                location: LocalLocation::Branch { git_dir, branch },
            } => db::ContextKey::Local(db::LocalLocation::Branch { git_dir, branch }),
            Self::ForgeBacked {
                repository_url,
                number,
            } => db::ContextKey::ForgeBacked {
                repository_url: repository_url.as_str(),
                number: *number,
            },
        }
    }
}