Files
oak-gpui/crates/editor/src/git/permalink.rs
T
Thorsten Ball 519655297a Support Bitbucket.org in permalinks (#8601)
This adds support for Bitbucket.org/Bitbucket Cloud repositories to the
`editor: copy permalink to line` and `editor: open permalink to line`
actions.

Fixes #5110.



Release Notes:

- Added support for repositories hosted on Bitbucket.org (Bitbucket
Cloud) to the `editor: copy permalink to line` and `editor: open
permalink to line` actions.
([#5110](https://github.com/zed-industries/zed/issues/5110)).
2024-02-29 14:11:30 +01:00

480 lines
17 KiB
Rust

use std::ops::Range;
use anyhow::{anyhow, Result};
use language::Point;
use url::Url;
enum GitHostingProvider {
Github,
Gitlab,
Gitee,
BitbucketCloud,
}
impl GitHostingProvider {
fn base_url(&self) -> Url {
let base_url = match self {
Self::Github => "https://github.com",
Self::Gitlab => "https://gitlab.com",
Self::Gitee => "https://gitee.com",
Self::BitbucketCloud => "https://bitbucket.org",
};
Url::parse(&base_url).unwrap()
}
/// Returns the fragment portion of the URL for the selected lines in
/// the representation the [`GitHostingProvider`] expects.
fn line_fragment(&self, selection: &Range<Point>) -> String {
if selection.start.row == selection.end.row {
let line = selection.start.row + 1;
match self {
Self::Github | Self::Gitlab | Self::Gitee => format!("L{}", line),
Self::BitbucketCloud => format!("lines-{}", line),
}
} else {
let start_line = selection.start.row + 1;
let end_line = selection.end.row + 1;
match self {
Self::Github => format!("L{}-L{}", start_line, end_line),
Self::Gitlab | Self::Gitee => format!("L{}-{}", start_line, end_line),
Self::BitbucketCloud => format!("lines-{}:{}", start_line, end_line),
}
}
}
}
pub fn build_permalink(
remote_url: &str,
sha: &str,
path: &str,
selection: Option<Range<Point>>,
) -> Result<Url> {
let ParsedGitRemote {
provider,
owner,
repo,
} = parse_git_remote_url(remote_url)
.ok_or_else(|| anyhow!("failed to parse Git remote URL"))?;
let path = match provider {
GitHostingProvider::Github => format!("{owner}/{repo}/blob/{sha}/{path}"),
GitHostingProvider::Gitlab => format!("{owner}/{repo}/-/blob/{sha}/{path}"),
GitHostingProvider::Gitee => format!("{owner}/{repo}/blob/{sha}/{path}"),
GitHostingProvider::BitbucketCloud => format!("{owner}/{repo}/src/{sha}/{path}"),
};
let line_fragment = selection.map(|selection| provider.line_fragment(&selection));
let mut permalink = provider.base_url().join(&path).unwrap();
permalink.set_fragment(line_fragment.as_deref());
Ok(permalink)
}
struct ParsedGitRemote<'a> {
pub provider: GitHostingProvider,
pub owner: &'a str,
pub repo: &'a str,
}
fn parse_git_remote_url(url: &str) -> Option<ParsedGitRemote> {
if url.starts_with("git@github.com:") || url.starts_with("https://github.com/") {
let repo_with_owner = url
.trim_start_matches("git@github.com:")
.trim_start_matches("https://github.com/")
.trim_end_matches(".git");
let (owner, repo) = repo_with_owner.split_once("/")?;
return Some(ParsedGitRemote {
provider: GitHostingProvider::Github,
owner,
repo,
});
}
if url.starts_with("git@gitlab.com:") || url.starts_with("https://gitlab.com/") {
let repo_with_owner = url
.trim_start_matches("git@gitlab.com:")
.trim_start_matches("https://gitlab.com/")
.trim_end_matches(".git");
let (owner, repo) = repo_with_owner.split_once("/")?;
return Some(ParsedGitRemote {
provider: GitHostingProvider::Gitlab,
owner,
repo,
});
}
if url.starts_with("git@gitee.com:") || url.starts_with("https://gitee.com/") {
let repo_with_owner = url
.trim_start_matches("git@gitee.com:")
.trim_start_matches("https://gitee.com/")
.trim_end_matches(".git");
let (owner, repo) = repo_with_owner.split_once("/")?;
return Some(ParsedGitRemote {
provider: GitHostingProvider::Gitee,
owner,
repo,
});
}
if url.contains("bitbucket.org") {
let (_, repo_with_owner) = url.trim_end_matches(".git").split_once("bitbucket.org")?;
let (owner, repo) = repo_with_owner
.trim_start_matches("/")
.trim_start_matches(":")
.split_once("/")?;
return Some(ParsedGitRemote {
provider: GitHostingProvider::BitbucketCloud,
owner,
repo,
});
}
None
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_build_github_permalink_from_ssh_url() {
let permalink = build_permalink(
"git@github.com:zed-industries/zed.git",
"e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
"crates/editor/src/git/permalink.rs",
None,
)
.unwrap();
let expected_url = "https://github.com/zed-industries/zed/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_github_permalink_from_ssh_url_single_line_selection() {
let permalink = build_permalink(
"git@github.com:zed-industries/zed.git",
"e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
"crates/editor/src/git/permalink.rs",
Some(Point::new(6, 1)..Point::new(6, 10)),
)
.unwrap();
let expected_url = "https://github.com/zed-industries/zed/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L7";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_github_permalink_from_ssh_url_multi_line_selection() {
let permalink = build_permalink(
"git@github.com:zed-industries/zed.git",
"e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
"crates/editor/src/git/permalink.rs",
Some(Point::new(23, 1)..Point::new(47, 10)),
)
.unwrap();
let expected_url = "https://github.com/zed-industries/zed/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L24-L48";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_github_permalink_from_https_url() {
let permalink = build_permalink(
"https://github.com/zed-industries/zed.git",
"b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
"crates/zed/src/main.rs",
None,
)
.unwrap();
let expected_url = "https://github.com/zed-industries/zed/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_github_permalink_from_https_url_single_line_selection() {
let permalink = build_permalink(
"https://github.com/zed-industries/zed.git",
"b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
"crates/zed/src/main.rs",
Some(Point::new(6, 1)..Point::new(6, 10)),
)
.unwrap();
let expected_url = "https://github.com/zed-industries/zed/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs#L7";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_github_permalink_from_https_url_multi_line_selection() {
let permalink = build_permalink(
"https://github.com/zed-industries/zed.git",
"b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
"crates/zed/src/main.rs",
Some(Point::new(23, 1)..Point::new(47, 10)),
)
.unwrap();
let expected_url = "https://github.com/zed-industries/zed/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs#L24-L48";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_permalink_from_ssh_url() {
let permalink = build_permalink(
"git@gitlab.com:zed-industries/zed.git",
"e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
"crates/editor/src/git/permalink.rs",
None,
)
.unwrap();
let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_permalink_from_ssh_url_single_line_selection() {
let permalink = build_permalink(
"git@gitlab.com:zed-industries/zed.git",
"e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
"crates/editor/src/git/permalink.rs",
Some(Point::new(6, 1)..Point::new(6, 10)),
)
.unwrap();
let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L7";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_permalink_from_ssh_url_multi_line_selection() {
let permalink = build_permalink(
"git@gitlab.com:zed-industries/zed.git",
"e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7",
"crates/editor/src/git/permalink.rs",
Some(Point::new(23, 1)..Point::new(47, 10)),
)
.unwrap();
let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/e6ebe7974deb6bb6cc0e2595c8ec31f0c71084b7/crates/editor/src/git/permalink.rs#L24-48";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_permalink_from_https_url() {
let permalink = build_permalink(
"https://gitlab.com/zed-industries/zed.git",
"b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
"crates/zed/src/main.rs",
None,
)
.unwrap();
let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_permalink_from_https_url_single_line_selection() {
let permalink = build_permalink(
"https://gitlab.com/zed-industries/zed.git",
"b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
"crates/zed/src/main.rs",
Some(Point::new(6, 1)..Point::new(6, 10)),
)
.unwrap();
let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs#L7";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitlab_permalink_from_https_url_multi_line_selection() {
let permalink = build_permalink(
"https://gitlab.com/zed-industries/zed.git",
"b2efec9824c45fcc90c9a7eb107a50d1772a60aa",
"crates/zed/src/main.rs",
Some(Point::new(23, 1)..Point::new(47, 10)),
)
.unwrap();
let expected_url = "https://gitlab.com/zed-industries/zed/-/blob/b2efec9824c45fcc90c9a7eb107a50d1772a60aa/crates/zed/src/main.rs#L24-48";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitee_permalink_from_ssh_url() {
let permalink = build_permalink(
"git@gitee.com:libkitten/zed.git",
"e5fe811d7ad0fc26934edd76f891d20bdc3bb194",
"crates/editor/src/git/permalink.rs",
None,
)
.unwrap();
let expected_url = "https://gitee.com/libkitten/zed/blob/e5fe811d7ad0fc26934edd76f891d20bdc3bb194/crates/editor/src/git/permalink.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitee_permalink_from_ssh_url_single_line_selection() {
let permalink = build_permalink(
"git@gitee.com:libkitten/zed.git",
"e5fe811d7ad0fc26934edd76f891d20bdc3bb194",
"crates/editor/src/git/permalink.rs",
Some(Point::new(6, 1)..Point::new(6, 10)),
)
.unwrap();
let expected_url = "https://gitee.com/libkitten/zed/blob/e5fe811d7ad0fc26934edd76f891d20bdc3bb194/crates/editor/src/git/permalink.rs#L7";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitee_permalink_from_ssh_url_multi_line_selection() {
let permalink = build_permalink(
"git@gitee.com:libkitten/zed.git",
"e5fe811d7ad0fc26934edd76f891d20bdc3bb194",
"crates/editor/src/git/permalink.rs",
Some(Point::new(23, 1)..Point::new(47, 10)),
)
.unwrap();
let expected_url = "https://gitee.com/libkitten/zed/blob/e5fe811d7ad0fc26934edd76f891d20bdc3bb194/crates/editor/src/git/permalink.rs#L24-48";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitee_permalink_from_https_url() {
let permalink = build_permalink(
"https://gitee.com/libkitten/zed.git",
"e5fe811d7ad0fc26934edd76f891d20bdc3bb194",
"crates/zed/src/main.rs",
None,
)
.unwrap();
let expected_url = "https://gitee.com/libkitten/zed/blob/e5fe811d7ad0fc26934edd76f891d20bdc3bb194/crates/zed/src/main.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitee_permalink_from_https_url_single_line_selection() {
let permalink = build_permalink(
"https://gitee.com/libkitten/zed.git",
"e5fe811d7ad0fc26934edd76f891d20bdc3bb194",
"crates/zed/src/main.rs",
Some(Point::new(6, 1)..Point::new(6, 10)),
)
.unwrap();
let expected_url = "https://gitee.com/libkitten/zed/blob/e5fe811d7ad0fc26934edd76f891d20bdc3bb194/crates/zed/src/main.rs#L7";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_gitee_permalink_from_https_url_multi_line_selection() {
let permalink = build_permalink(
"https://gitee.com/libkitten/zed.git",
"e5fe811d7ad0fc26934edd76f891d20bdc3bb194",
"crates/zed/src/main.rs",
Some(Point::new(23, 1)..Point::new(47, 10)),
)
.unwrap();
let expected_url = "https://gitee.com/libkitten/zed/blob/e5fe811d7ad0fc26934edd76f891d20bdc3bb194/crates/zed/src/main.rs#L24-48";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_parse_git_remote_url_bitbucket_https_with_username() {
let url = "https://thorstenballzed@bitbucket.org/thorstenzed/testingrepo.git";
let parsed = parse_git_remote_url(url).unwrap();
assert!(matches!(
parsed.provider,
GitHostingProvider::BitbucketCloud
));
assert_eq!(parsed.owner, "thorstenzed");
assert_eq!(parsed.repo, "testingrepo");
}
#[test]
fn test_parse_git_remote_url_bitbucket_https_without_username() {
let url = "https://bitbucket.org/thorstenzed/testingrepo.git";
let parsed = parse_git_remote_url(url).unwrap();
assert!(matches!(
parsed.provider,
GitHostingProvider::BitbucketCloud
));
assert_eq!(parsed.owner, "thorstenzed");
assert_eq!(parsed.repo, "testingrepo");
}
#[test]
fn test_parse_git_remote_url_bitbucket_git() {
let url = "git@bitbucket.org:thorstenzed/testingrepo.git";
let parsed = parse_git_remote_url(url).unwrap();
assert!(matches!(
parsed.provider,
GitHostingProvider::BitbucketCloud
));
assert_eq!(parsed.owner, "thorstenzed");
assert_eq!(parsed.repo, "testingrepo");
}
#[test]
fn test_build_bitbucket_permalink_from_ssh_url() {
let permalink = build_permalink(
"git@bitbucket.org:thorstenzed/testingrepo.git",
"f00b4r",
"main.rs",
None,
)
.unwrap();
let expected_url = "https://bitbucket.org/thorstenzed/testingrepo/src/f00b4r/main.rs";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_bitbucket_permalink_from_ssh_url_single_line_selection() {
let permalink = build_permalink(
"git@bitbucket.org:thorstenzed/testingrepo.git",
"f00b4r",
"main.rs",
Some(Point::new(6, 1)..Point::new(6, 10)),
)
.unwrap();
let expected_url =
"https://bitbucket.org/thorstenzed/testingrepo/src/f00b4r/main.rs#lines-7";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
#[test]
fn test_build_bitbucket_permalink_from_ssh_url_multi_line_selection() {
let permalink = build_permalink(
"git@bitbucket.org:thorstenzed/testingrepo.git",
"f00b4r",
"main.rs",
Some(Point::new(23, 1)..Point::new(47, 10)),
)
.unwrap();
let expected_url =
"https://bitbucket.org/thorstenzed/testingrepo/src/f00b4r/main.rs#lines-24:48";
assert_eq!(permalink.to_string(), expected_url.to_string())
}
}