prdoclib 0.0.7

prdoclib is a lib
Documentation 
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

//! Set of utils
use crate::{common::PRNumber, config::PRDocConfig, error};
use std::{
	env,
	fs::read_dir,
	io::{self, ErrorKind},
	path::PathBuf,
};

/// Type alias for the result of parsing a file
pub type ParseResult = (String, bool, Option<PRNumber>);

/// Get the project root (relative to closest Cargo.lock file)
pub fn get_project_root() -> io::Result<PathBuf> {
	let path = env::current_dir()?;
	let path_ancestors = path.as_path().ancestors();

	for p in path_ancestors {
		let has_cargo = read_dir(p)?.any(|p| p.unwrap().file_name() == "Cargo.lock");
		if has_cargo {
			return Ok(PathBuf::from(p))
		}
	}
	Err(io::Error::new(ErrorKind::NotFound, "Ran out of places to find Cargo.toml"))
}

pub(crate) fn get_numbers_from_file(file: &PathBuf) -> error::Result<Vec<ParseResult>> {
	Ok(std::fs::read_to_string(file)?
		.lines()
		.map(|line| {
			let num = line.parse::<PRNumber>();
			let valid = num.is_ok();
			let number = num.ok();
			(line.to_string(), valid, number)
		})
		.collect())
}

/// Return the path of the folder where PRDoc are stored
pub fn get_pr_doc_folder(output_dir: Option<PathBuf>, config: &PRDocConfig) -> PathBuf {
	if let Some(path) = output_dir {
		return path
	}

	config.output_dir.clone()
}

/// Get the template path from the config
pub fn get_template_path(config: &PRDocConfig) -> PathBuf {
	config.template.clone()
}

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

	#[test]
	fn it_should_find_our_project_root() {
		let project_root = get_project_root().expect("There is no project root");
		let toml_path = project_root.to_str().unwrap().to_owned() + "/Cargo.toml";
		assert!(!toml_path.is_empty());
	}
}