Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: canonicalize more IETF urls #151

Merged
merged 2 commits into from
Jan 15, 2025
Merged

feat: canonicalize more IETF urls #151

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94ecd79
feat: canonicalize more IETF urls
camshaft Jan 10, 2025
1bb8b6f
Merge branch 'main' into camshaft/more-url-canonicalization
WesleyRosenblum Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 68 additions & 12 deletions duvet/src/target.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use crate::{
use core::{fmt, str::FromStr};
use duvet_core::{diagnostic::IntoDiagnostic, file::SourceFile, path::Path, progress, query};
use std::{
borrow::Cow,
collections::{HashMap, HashSet},
sync::Arc,
};
Expand Down Expand Up @@ -127,7 +128,7 @@ impl TargetPath {
pub async fn load(&self, spec_download_path: Option<&Path>) -> Result<SourceFile> {
match self {
Self::Url(url) => {
let canonical_url = Self::canonical_url(url.as_str());
let canonical_url = Self::canonical_url(url.as_str()).to_string();
let path = self.local(spec_download_path);

let progress = if !path.exists() {
Expand Down Expand Up @@ -158,28 +159,55 @@ impl TargetPath {
}
.to_path_buf();
path.push("specs");
path.push(url.host_str().expect("url should have host"));
path.extend(url.path_segments().expect("url should have path"));

let mut push_url = |url: &Url| {
path.push(url.host_str().expect("url should have host"));
path.extend(url.path_segments().expect("url should have path"));
};

let canonical_url = Self::canonical_url(url.as_str());

if matches!(canonical_url, Cow::Borrowed(_)) {
push_url(url)
} else {
let url = Url::parse(&canonical_url).unwrap();
push_url(&url)
}

path.set_extension("txt");
path.into()
}
Self::Path(path) => path.clone(),
}
}

fn canonical_url(url: &str) -> String {
// rewrite some of the IETF links for convenience
if let Some(rfc) = url.strip_prefix("https://tools.ietf.org/rfc/") {
let rfc = rfc.trim_end_matches(".txt").trim_end_matches(".html");
return format!("https://www.rfc-editor.org/rfc/{}.txt", rfc);
fn canonical_url(url: &str) -> Cow<str> {
fn remove_extension(url: &str) -> &str {
url.trim_end_matches('/')
.trim_end_matches(".txt")
.trim_end_matches(".html")
.trim_end_matches(".xml")
.trim_end_matches(".pdf")
}

if url.starts_with("https://www.rfc-editor.org/rfc/") {
let rfc = url.trim_end_matches(".txt").trim_end_matches(".html");
return format!("{}.txt", rfc);
// rewrite some of the IETF links for convenience
let patterns = [
"https://www.rfc-editor.org/rfc/rfc",
"http://www.rfc-editor.org/rfc/rfc",
"https://tools.ietf.org/rfc/rfc",
"http://tools.ietf.org/rfc/rfc",
"https://datatracker.ietf.org/doc/html/rfc",
"http://datatracker.ietf.org/doc/html/rfc",
];

for pattern in patterns {
if let Some(rfc) = url.strip_prefix(pattern) {
let rfc = remove_extension(rfc);
return format!("{}{rfc}.txt", patterns[0]).into();
}
}

url.to_owned()
url.into()
}
}

Expand All @@ -197,3 +225,31 @@ impl FromStr for TargetPath {
Ok(Self::Path(path))
}
}

#[cfg(test)]
mod tests {
use super::TargetPath;

#[test]
fn canonical_url_test() {
let urls = [
"https://www.rfc-editor.org/rfc/rfc9000.txt",
"https://www.rfc-editor.org/rfc/rfc9000",
"https://www.rfc-editor.org/rfc/rfc9000.html",
"https://www.rfc-editor.org/rfc/rfc9000.xml",
"https://www.rfc-editor.org/rfc/rfc9000.pdf",
"https://datatracker.ietf.org/doc/html/rfc9000",
"https://datatracker.ietf.org/doc/html/rfc9000.html",
"https://datatracker.ietf.org/doc/html/rfc9000.txt",
"https://tools.ietf.org/rfc/rfc9000",
"https://tools.ietf.org/rfc/rfc9000.txt",
"https://tools.ietf.org/rfc/rfc9000.html",
];

let expected = urls[0];
for url in urls {
let canonical = TargetPath::canonical_url(url);
assert_eq!(expected, canonical);
}
}
}
Loading