ProvableHQ/leo
1
1
Fork 0
mirror of https://github.com/ProvableHQ/leo.git synced 2024-11-23 23:23:50 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2128 from AleoHQ/fix/package-name-check

Browse Source 
Fix validation for package name.
This commit is contained in:
d0cd 2022-10-15 10:38:23 -07:00 committed by GitHub
commit 05ec1109db
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
compiler/span/src/source_map.rs
View File

@ -412,7 +412,7 @@ fn analyze_source_file(src: &str, source_file_start_pos: BytePos) -> (Vec<BytePo
let src_bytes = src.as_bytes(); let src_bytes = src.as_bytes();
while i < src.len() { while i < src.len() {
let i_usize = i as usize; let i_usize = i;
let byte = src_bytes[i_usize]; let byte = src_bytes[i_usize];
// How much to advance to get to the next UTF-8 char in the string. // How much to advance to get to the next UTF-8 char in the string.

50
leo/package/src/package.rs
View File

@ -51,9 +51,7 @@ impl Package {
/// Returns `true` if the package name is valid. /// Returns `true` if the package name is valid.
/// ///
/// Package names must be lowercase and composed solely /// Package names can only contain ASCII alphanumeric characters and underscores.
/// of ASCII alphanumeric characters, and may be word-separated
/// by a single dash '-'.
pub fn is_package_name_valid(package_name: &str) -> bool { pub fn is_package_name_valid(package_name: &str) -> bool {
// Check that the package name is nonempty. // Check that the package name is nonempty.
if package_name.is_empty() { if package_name.is_empty() {
@ -61,47 +59,27 @@ impl Package {
return false; return false;
} }
let mut previous = package_name.chars().next().unwrap(); let first = package_name.chars().next().unwrap();
// Check that the first character is not a dash. // Check that the first character is not an underscore.
if previous == '-' { if first == '_' {
tracing::error!("Project names cannot begin with a dash"); tracing::error!("Project names cannot begin with an underscore");
return false; return false;
} }
// Check that the first character is not a number. // Check that the first character is not a number.
if previous.is_numeric() { if first.is_numeric() {
tracing::error!("Project names cannot begin with a number"); tracing::error!("Project names cannot begin with a number");
return false; return false;
} }
// Iterate and check that the package name is valid. // Iterate and check that the package name is valid.
for current in package_name.chars() { for current in package_name.chars() {
// Check that the package name is lowercase. // Check that the package name contains only ASCII alphanumeric or underscores.
if current.is_ascii_uppercase() && current != '-' { if !current.is_ascii_alphanumeric() && current != '_' {
tracing::error!("Project names must be all lowercase"); tracing::error!("Project names must can only contain ASCII alphanumeric characters and underscores.");
return false; return false;
} }
// Check that the package name is only ASCII alphanumeric or a dash.
if !current.is_ascii_alphanumeric() && current != '-' {
tracing::error!("Project names must be ASCII alphanumeric, and may be word-separated with a dash");
return false;
}
// If the previous character was a dash, check that the current character is not a dash.
if previous == '-' && current == '-' {
tracing::error!("Project names may only be word-separated by one dash");
return false;
}
previous = current;
}
// Check that the last character is not a dash.
if previous == '-' {
tracing::error!("Project names cannot end with a dash");
return false;
} }
true true
@ -202,22 +180,24 @@ mod tests {
#[test] #[test]
fn test_is_package_name_valid() { fn test_is_package_name_valid() {
assert!(Package::is_package_name_valid("foo")); assert!(Package::is_package_name_valid("foo"));
assert!(Package::is_package_name_valid("foo-bar")); assert!(Package::is_package_name_valid("foo_bar"));
assert!(Package::is_package_name_valid("foo-bar-baz"));
assert!(Package::is_package_name_valid("foo1")); assert!(Package::is_package_name_valid("foo1"));
assert!(Package::is_package_name_valid("foo-1")); assert!(Package::is_package_name_valid("foo_bar___baz_"));
assert!(!Package::is_package_name_valid("foo-bar"));
assert!(!Package::is_package_name_valid("foo-bar-baz"));
assert!(!Package::is_package_name_valid("foo-1"));
assert!(!Package::is_package_name_valid("")); assert!(!Package::is_package_name_valid(""));
assert!(!Package::is_package_name_valid("-")); assert!(!Package::is_package_name_valid("-"));
assert!(!Package::is_package_name_valid("-foo")); assert!(!Package::is_package_name_valid("-foo"));
assert!(!Package::is_package_name_valid("-foo-")); assert!(!Package::is_package_name_valid("-foo-"));
assert!(!Package::is_package_name_valid("_foo"));
assert!(!Package::is_package_name_valid("foo--bar")); assert!(!Package::is_package_name_valid("foo--bar"));
assert!(!Package::is_package_name_valid("foo---bar")); assert!(!Package::is_package_name_valid("foo---bar"));
assert!(!Package::is_package_name_valid("foo--bar--baz")); assert!(!Package::is_package_name_valid("foo--bar--baz"));
assert!(!Package::is_package_name_valid("foo---bar---baz")); assert!(!Package::is_package_name_valid("foo---bar---baz"));
assert!(!Package::is_package_name_valid("foo*bar")); assert!(!Package::is_package_name_valid("foo*bar"));
assert!(!Package::is_package_name_valid("foo,bar")); assert!(!Package::is_package_name_valid("foo,bar"));
assert!(!Package::is_package_name_valid("foo_bar"));
assert!(!Package::is_package_name_valid("1-foo")); assert!(!Package::is_package_name_valid("1-foo"));
} }
} }