co-author 0.1.0

Co-Author your git commits
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use crate::conf;
use std::fs;

use serial_test::serial;

use crate::authors::author::Author;
use crate::authors::author::AuthorsRepo;
use crate::authors::fs_repo::FSRepo;

#[test]
fn should_init_from_a_given_existing_file() {
	assert!(FSRepo::from(conf::authors_file()).is_ok());
}

#[test]
fn should_not_init_if_a_given_file_does_not_exist() {
	assert!(FSRepo::from("no_file_here".to_string()).is_err());
}

#[test]
#[serial]
fn should_look_in_cwd_when_no_authors_file_is_found_in_default_path() {
	let authors_file_in_cwd = "./authors";
	fs::File::create(authors_file_in_cwd).unwrap();

	let repo = FSRepo::default("/not_real".to_string());
	assert!(repo.is_ok());

	fs::remove_file(authors_file_in_cwd).unwrap();
}

#[test]
#[serial]
fn should_fail_to_init_when_no_valid_file_is_found() {
	assert!(FSRepo::default("/not_real".to_string()).is_err());
}

#[test]
fn should_fetch_all_available_authors() {
	let repo = FSRepo::from(conf::authors_file()).unwrap();

	let actual_authors = repo.all();

	let expected_authors = Vec::from([
		Author::new("a", "Name Surname", "someone@users.noreply.github.com"),
		Author::new("b", "username", "something@gmail.com"),
		Author::new("b", "username2", "something2@gmail.com"),
		Author::new("ab", "Another Surname", "someone@something.hi"),
	]);
	assert_eq!(actual_authors, expected_authors);
}

#[test]
fn should_fetch_authors_based_on_alias() {
	let repo = FSRepo::from(conf::authors_file()).unwrap();

	let alias = "a";
	let actual_authors = repo.find(Vec::from([String::from(alias)]));

	let expected_authors = Vec::from([Author::new(alias, "Name Surname", "someone@users.noreply.github.com")]);
	assert_eq!(actual_authors, expected_authors);
}

#[test]
fn should_fetch_all_authors_for_a_given_alias() {
	let repo = FSRepo::from(conf::authors_file()).unwrap();

	let alias = "b";
	let actual_authors = repo.find(Vec::from([String::from(alias)]));

	let expected_authors = Vec::from([
		Author::new(alias, "username", "something@gmail.com"),
		Author::new(alias, "username2", "something2@gmail.com"),
	]);
	assert_eq!(actual_authors, expected_authors);
}

#[test]
fn should_return_an_empty_list_if_no_author_mathces_alias() {
	let repo = FSRepo::from(conf::authors_file()).unwrap();

	let alias = "z";
	let actual_authors = repo.find(Vec::from([String::from(alias)]));

	let expected_authors = Vec::from([]);
	assert_eq!(actual_authors, expected_authors);
}