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 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
use std::io::{BufRead, BufReader, Read};
use thiserror::Error;
#[derive(Error, Debug)]
pub enum YamlSplitError {
#[error(transparent)]
IOError(#[from] std::io::Error),
}
/// `DocumentIterator` is an iterator over individual YAML documents in a file or stream.
///
/// For example, the following YAML file contains two separate documents:
/// ```yaml
/// hello: world
/// ---
/// hello: rust
/// ```
///
/// The first item in this iterator will be:
/// ```yaml
/// hello: world
/// ```
///
/// The second item will be (the "header" / directives end marker "---" is considered part of the document):
/// ```yaml
/// ---
/// hello: rust
/// ```
///
/// Each item's output will be suitable for passing to `serde-yaml`, `yaml-rust` or
/// similar libraries for parsing. Each item can also be an error, letting you opt for
/// safe handling of errors when dealing with lots of files.
///
/// ```
/// use std::fs::File;
/// # use std::fs::remove_file;
/// use yaml_split::DocumentIterator;
/// # use std::io::Write;
/// let mut file = File::options()
/// .create(true)
/// .write(true)
/// .open("test.yaml")
/// .unwrap()
/// .write(b"hello: world");
///
/// let read_file = File::open("test.yaml").unwrap();
/// let doc_iter = DocumentIterator::new(read_file);
///
/// for doc in doc_iter {
/// println!("{}", doc.unwrap());
/// }
///
/// # remove_file("test.yaml").unwrap();
/// ```
///
/// This also correctly handles less common areas of the YAML spec including
/// directives, comments and document end markers.
///
/// ```
/// use yaml_split::DocumentIterator;
///
/// let input = r#"
///
/// ## a header comment
/// %YAML 1.2
/// ---
/// hello: world
/// ...
/// ---
/// hello: rust
/// ---
/// ## a body comment
/// hello: everyone
/// "#;
///
/// let mut doc_iter = DocumentIterator::new(input.as_bytes());
///
/// assert_eq!(r#"
///
/// ## a header comment
/// %YAML 1.2
/// ---
/// hello: world
/// "#, doc_iter.next().unwrap().unwrap());
/// assert_eq!(r#"---
/// hello: rust
/// "#, doc_iter.next().unwrap().unwrap());
/// assert_eq!(r#"---
/// ## a body comment
/// hello: everyone
/// "#, doc_iter.next().unwrap().unwrap());
/// ```
pub struct DocumentIterator<R>
where
R: Read,
{
reader: BufReader<R>,
disambiguated: bool,
in_header: bool,
prepend_next: Option<String>,
}
impl<'a, R: Read + 'a> DocumentIterator<R> {
/// `new()` creates a new DocumentIterator over a given `reader`'s contents.
///
/// This reader can be a reader for a file:
/// ```
/// use std::fs::File;
/// # use std::fs::remove_file;
/// use yaml_split::DocumentIterator;
/// # use std::io::Write;
/// let mut file = File::options()
/// .create(true)
/// .write(true)
/// .open("test.yml")
/// .unwrap()
/// .write(b"hello: world");
///
/// let read_file = File::open("test.yml").unwrap();
/// let doc_iter = DocumentIterator::new(read_file);
///
/// for doc in doc_iter {
/// println!("{}", doc.unwrap());
/// }
/// # remove_file("test.yml").unwrap();
/// ```
///
/// Or the reader can be a simple byte array (useful for strings):
/// ```
/// use yaml_split::DocumentIterator;
/// let yaml = r#"
/// hello: world
/// ---
/// hello: rust
/// "#;
///
/// let mut doc_iter = DocumentIterator::new(yaml.as_bytes());
///
/// assert_eq!(r#"
/// hello: world
/// "#, doc_iter.next().unwrap().unwrap());
/// assert_eq!(r#"---
/// hello: rust
/// "#, doc_iter.next().unwrap().unwrap());
/// assert_eq!(true, doc_iter.next().is_none());
///
/// // or in a loop:
/// for doc in doc_iter {
/// println!("{}", doc.unwrap());
/// }
/// ```
pub fn new(reader: R) -> DocumentIterator<R> {
let br = BufReader::new(reader);
DocumentIterator {
reader: br,
disambiguated: false,
in_header: false,
prepend_next: None,
}
}
}
impl<R: Read> Iterator for DocumentIterator<R> {
type Item = Result<String, YamlSplitError>;
fn next(&mut self) -> Option<Self::Item> {
let mut buf = String::new();
let mut current_file = match &self.prepend_next {
Some(next) => next.clone(),
None => String::new(),
};
self.prepend_next = None;
// First, we must disambiguate between a bare document and a directive at the top of the
// file (before any directive end "---" markers). To do this, we must look for a #, % or
// other non-whitespace character as the first character on a line:
//
// - # indicates a comment, the line will be ignored
// - % indicates a directive, we should assume the rest of the header is also a directive as
// % is not a valid character at the start of a line, before a --- is seen.
// - anything else indicates we must currently be looking at a bare document's content
//
// XXX: This loop also builds up buffers that are shared with the next loop. The reader
// is also shared and so the next loop will start off where this one ends and assume the
// buffers have the correct content.
loop {
if self.disambiguated {
break;
}
// Empty the buffer. read_line appends, and we don't want that.
buf.clear();
match self.reader.read_line(&mut buf) {
Ok(l) => {
if l == 0 {
// We hit EOF already, and it's still not clear
// this file must have only whitespace, comments or be completely empty.
return None;
}
for c in buf.chars() {
match c {
// Spaces, tabs and carriage returns don't tell us anything,
// keep searching the line.
' ' | '\t' | '\r' => continue,
// # means this line is a comment, nothing to do.
// \n is a newline, also nothing to do, this line didn't
// tell us anything.
'#' | '\n' => break,
// % means this line is a directive, we must be in a header
'%' => {
self.disambiguated = true;
self.in_header = true;
break;
}
// anything else must mean we are in a bare document
_ => {
self.disambiguated = true;
self.in_header = false;
break;
}
};
}
// Append the current line to the document
current_file = current_file + &buf;
}
Err(e) => {
return Some(Err(e.into()));
}
}
}
// Now that we know whether we are starting off in a directive or a document, we can
// parse the rest of the YAML. In this loop we will look for the start and end of documents
// as our YAML parser does not support parsing multiple documents at once.
loop {
buf.clear();
match self.reader.read_line(&mut buf) {
Ok(l) => {
let hit_eof = l == 0;
let cf_len = current_file.len();
// If there is absolutely nothing to do (i.e. the current file data is empty, and
// we're at EOF), just exit the loop.
if hit_eof && cf_len == 0 {
return None;
}
let end_of_doc = buf.starts_with("...");
let directives_end = buf.starts_with("---");
if !self.in_header && directives_end {
// a new document has started already.
self.in_header = false;
// to not lose the current line, including any directives that might
// be on the line (after the "---"), we need to prepend it
// the next time someone calls next()
self.prepend_next = Some(buf);
return Some(Ok(current_file));
} else if end_of_doc {
// this document has ended, but we don't need this line.
// the next line must be a header, or "---"
self.in_header = true;
return Some(Ok(current_file));
} else if hit_eof {
// this document has ended, and nothing will follow.
return Some(Ok(current_file));
} else if self.in_header && directives_end {
self.in_header = false;
}
current_file = current_file + &buf;
}
Err(e) => {
return Some(Err(e.into()));
}
};
}
}
}
#[cfg(test)]
mod tests {
use crate::DocumentIterator;
use std::io::BufReader;
fn str_reader(s: &[u8]) -> BufReader<&[u8]> {
BufReader::new(s)
}
#[test]
fn bare_document() {
let input = "abc: def";
let reader = str_reader(input.as_bytes());
let mut doc_iter = DocumentIterator::new(reader);
let next = doc_iter.next().unwrap().unwrap();
assert_eq!(&next, "abc: def");
let fin = doc_iter.next().is_none();
assert_eq!(true, fin);
}
#[test]
fn document_with_header() {
let input = r#"
---
abc: def
"#;
let reader = str_reader(input.as_bytes());
let mut doc_iter = DocumentIterator::new(reader);
let next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"
---
abc: def
"#
);
let fin = doc_iter.next().is_none();
assert_eq!(true, fin);
}
#[test]
fn document_with_header_and_directive() {
let input = r#"
%YAML 1.2
---
abc: def
"#;
let reader = str_reader(input.as_bytes());
let mut doc_iter = DocumentIterator::new(reader);
let next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"
%YAML 1.2
---
abc: def
"#
);
let fin = doc_iter.next().is_none();
assert_eq!(true, fin);
}
#[test]
fn two_documents() {
let input = r#"abc: def
---
aaa: bbb
"#;
let reader = str_reader(input.as_bytes());
let mut doc_iter = DocumentIterator::new(reader);
let mut next = doc_iter.next().unwrap().unwrap();
assert_eq!(&next, "abc: def\n");
next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"---
aaa: bbb
"#
);
let fin = doc_iter.next().is_none();
assert_eq!(true, fin);
}
#[test]
fn two_documents_with_headers() {
let input = r#"%YAML 1.2
---
abc: def
...
%YAML 1.2
---
aaa: bbb
"#;
let reader = str_reader(input.as_bytes());
let mut doc_iter = DocumentIterator::new(reader);
let mut next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"%YAML 1.2
---
abc: def
"#
);
next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"
%YAML 1.2
---
aaa: bbb
"#
);
let fin = doc_iter.next().is_none();
assert_eq!(true, fin);
}
#[test]
fn document_medley() {
let input = r#"%YAML 1.2
---
abc: def
---
%YAML: "not a real directive"
---
aaa: bbb
...
---
...
---
final: "document"
"#;
let reader = str_reader(input.as_bytes());
let mut doc_iter = DocumentIterator::new(reader);
let mut next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"%YAML 1.2
---
abc: def
"#
);
next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"---
%YAML: "not a real directive"
"#
);
next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"---
aaa: bbb
"#
);
next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"---
"#
);
next = doc_iter.next().unwrap().unwrap();
assert_eq!(
&next,
r#"---
final: "document"
"#
);
let fin = doc_iter.next().is_none();
assert_eq!(true, fin);
}
}