|
| 1 | +use std::io; |
| 2 | + |
| 3 | +use eyre::Result; |
| 4 | +use tokio::fs; |
| 5 | + |
| 6 | +/// read_q_script reads the file passed in and returns its contents. If it's first line begins with |
| 7 | +/// a shebang (#!), that line and consecutive lines beginning with a '#' character are skipped. |
| 8 | +pub async fn read_q_script(script: &str) -> Result<String, io::Error> { |
| 9 | + match fs::read_to_string(&script).await { |
| 10 | + Ok(content) => { |
| 11 | + let mut lines = content.lines().peekable(); |
| 12 | + let mut result_lines = Vec::new(); |
| 13 | + |
| 14 | + // Only skip the first line if it starts with '#!' |
| 15 | + if lines.peek().is_some_and(|line| line.starts_with("#!")) { |
| 16 | + lines.next(); |
| 17 | + // Skip consecutive comment lines after shebang |
| 18 | + while lines.peek().is_some_and(|line| line.starts_with('#')) { |
| 19 | + lines.next(); |
| 20 | + } |
| 21 | + } |
| 22 | + |
| 23 | + result_lines.extend(lines); |
| 24 | + Ok(result_lines.join("\n")) |
| 25 | + }, |
| 26 | + Err(e) => Err(e), |
| 27 | + } |
| 28 | +} |
| 29 | +#[cfg(test)] |
| 30 | +mod tests { |
| 31 | + use std::io::Write; |
| 32 | + |
| 33 | + use tempfile::NamedTempFile; |
| 34 | + |
| 35 | + use super::*; |
| 36 | + |
| 37 | + fn create_temp_script(content: &str) -> NamedTempFile { |
| 38 | + let mut file = NamedTempFile::new().unwrap(); |
| 39 | + file.write_all(content.as_bytes()).unwrap(); |
| 40 | + file |
| 41 | + } |
| 42 | + |
| 43 | + #[tokio::test] |
| 44 | + async fn test_script_with_shebang_and_consecutive_comments() { |
| 45 | + let content = |
| 46 | + "#!/usr/bin/env q\n# This is a comment\n# Another comment\nactual content\n# Later comment\nmore content"; |
| 47 | + let file = create_temp_script(content); |
| 48 | + |
| 49 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 50 | + assert_eq!(result.unwrap(), "actual content\n# Later comment\nmore content"); |
| 51 | + } |
| 52 | + |
| 53 | + #[tokio::test] |
| 54 | + async fn test_script_with_shebang_no_comments() { |
| 55 | + let content = "#!/usr/bin/env q\nactual content\nmore content"; |
| 56 | + let file = create_temp_script(content); |
| 57 | + |
| 58 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 59 | + assert_eq!(result.unwrap(), "actual content\nmore content"); |
| 60 | + } |
| 61 | + |
| 62 | + #[tokio::test] |
| 63 | + async fn test_script_without_shebang_with_comments() { |
| 64 | + let content = "# This is a comment\nactual content\n# Later comment\nmore content"; |
| 65 | + let file = create_temp_script(content); |
| 66 | + |
| 67 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 68 | + assert_eq!( |
| 69 | + result.unwrap(), |
| 70 | + "# This is a comment\nactual content\n# Later comment\nmore content" |
| 71 | + ); |
| 72 | + } |
| 73 | + |
| 74 | + #[tokio::test] |
| 75 | + async fn test_script_without_shebang_no_comments() { |
| 76 | + let content = "actual content\nmore content"; |
| 77 | + let file = create_temp_script(content); |
| 78 | + |
| 79 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 80 | + assert_eq!(result.unwrap(), "actual content\nmore content"); |
| 81 | + } |
| 82 | + |
| 83 | + #[tokio::test] |
| 84 | + async fn test_script_with_only_shebang() { |
| 85 | + let content = "#!/usr/bin/env q"; |
| 86 | + let file = create_temp_script(content); |
| 87 | + |
| 88 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 89 | + assert_eq!(result.unwrap(), ""); |
| 90 | + } |
| 91 | + |
| 92 | + #[tokio::test] |
| 93 | + async fn test_script_with_shebang_and_only_comments() { |
| 94 | + let content = "#!/usr/bin/env q\n# Comment 1\n# Comment 2"; |
| 95 | + let file = create_temp_script(content); |
| 96 | + |
| 97 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 98 | + assert_eq!(result.unwrap(), ""); |
| 99 | + } |
| 100 | + |
| 101 | + #[tokio::test] |
| 102 | + async fn test_script_with_non_shebang_hash_first_line() { |
| 103 | + let content = "#not a shebang\nactual content\nmore content"; |
| 104 | + let file = create_temp_script(content); |
| 105 | + |
| 106 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 107 | + assert_eq!(result.unwrap(), "#not a shebang\nactual content\nmore content"); |
| 108 | + } |
| 109 | + |
| 110 | + #[tokio::test] |
| 111 | + async fn test_empty_script() { |
| 112 | + let content = ""; |
| 113 | + let file = create_temp_script(content); |
| 114 | + |
| 115 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 116 | + assert_eq!(result.unwrap(), ""); |
| 117 | + } |
| 118 | + |
| 119 | + #[tokio::test] |
| 120 | + async fn test_script_with_mixed_content() { |
| 121 | + let content = "#!/usr/bin/env q\n# Header comment\n# Another header comment\n\nactual content\n# Inline comment\nmore content\n\n# Final comment"; |
| 122 | + let file = create_temp_script(content); |
| 123 | + |
| 124 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 125 | + assert_eq!( |
| 126 | + result.unwrap(), |
| 127 | + "\nactual content\n# Inline comment\nmore content\n\n# Final comment" |
| 128 | + ); |
| 129 | + } |
| 130 | + |
| 131 | + #[tokio::test] |
| 132 | + async fn test_nonexistent_file() { |
| 133 | + let result = read_q_script("/nonexistent/file.q").await; |
| 134 | + assert!(result.is_err()); |
| 135 | + } |
| 136 | + |
| 137 | + #[tokio::test] |
| 138 | + async fn test_script_with_shebang_and_empty_lines() { |
| 139 | + let content = "#!/usr/bin/env q\n# Comment\n\n\nactual content"; |
| 140 | + let file = create_temp_script(content); |
| 141 | + |
| 142 | + let result = read_q_script(file.path().to_string_lossy().as_ref()).await; |
| 143 | + assert_eq!(result.unwrap(), "\n\nactual content"); |
| 144 | + } |
| 145 | +} |
0 commit comments