edward/git-config
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Compare commits

base: edward:594ee8ac0c5620be279c7520e9f4478ecf4eb582
Branches Tags
edward:master
..
compare: edward:93e6e2eed3f855786d1686dcfce1b2f4f21e4fb7
Branches Tags
edward:master

No commits in common. "594ee8ac0c5620be279c7520e9f4478ecf4eb582" and "93e6e2eed3f855786d1686dcfce1b2f4f21e4fb7" have entirely different histories.
594ee8ac0c ... 93e6e2eed3

3 changed files with 548 additions and 894 deletions
Show stats Expand all files Collapse all files

557
src/config.rs
View file

@ -2,25 +2,14 @@ use std::collections::HashMap;
use crate::parser::{parse_from_str, Event, Parser, ParserError}; use crate::parser::{parse_from_str, Event, Parser, ParserError};
#[derive(PartialEq, Eq, Hash, Copy, Clone, PartialOrd, Ord, Debug)] #[derive(PartialEq, Eq, Hash, Copy, Clone, PartialOrd, Ord)]
struct SectionId(usize); struct SectionId(usize);
#[derive(Debug, PartialEq, Eq)]
enum LookupTreeNode<'a> { enum LookupTreeNode<'a> {
Terminal(Vec<SectionId>), Terminal(Vec<SectionId>),
NonTerminal(HashMap<&'a str, Vec<SectionId>>), NonTerminal(HashMap<&'a str, Vec<SectionId>>),
} }
#[derive(Debug, PartialEq, Eq)]
pub enum GitConfigError<'a> {
/// The requested section does not exist.
SectionDoesNotExist(&'a str),
/// The requested subsection does not exist.
SubSectionDoesNotExist(Option<&'a str>),
/// The key does not exist in the requested section.
KeyDoesNotExist(&'a str),
}
/// High level `git-config` reader and writer. /// High level `git-config` reader and writer.
pub struct GitConfig<'a> { pub struct GitConfig<'a> {
front_matter_events: Vec<Event<'a>>, front_matter_events: Vec<Event<'a>>,
@ -38,13 +27,14 @@ impl<'a> GitConfig<'a> {
} }
pub fn from_parser(parser: Parser<'a>) -> Self { pub fn from_parser(parser: Parser<'a>) -> Self {
let mut new_self = Self { // Monotonically increasing
front_matter_events: vec![], let mut section_id_counter: usize = 0;
sections: HashMap::new(),
section_lookup_tree: HashMap::new(), // Fields for the struct
section_header_separators: HashMap::new(), let mut front_matter_events: Vec<Event<'a>> = vec![];
section_id_counter: 0, let mut sections: HashMap<SectionId, Vec<Event<'a>>> = HashMap::new();
}; let mut section_lookup_tree: HashMap<&str, Vec<LookupTreeNode>> = HashMap::new();
let mut section_header_separators = HashMap::new();
// Current section that we're building // Current section that we're building
let mut current_section_name: Option<&str> = None; let mut current_section_name: Option<&str> = None;
@ -53,12 +43,51 @@ impl<'a> GitConfig<'a> {
for event in parser.into_iter() { for event in parser.into_iter() {
match event { match event {
e @ Event::Comment(_) => match maybe_section {
Some(ref mut section) => section.push(e),
None => front_matter_events.push(e),
},
Event::SectionHeader(header) => { Event::SectionHeader(header) => {
new_self.push_section( // Push current section to struct
&mut current_section_name, let new_section_id = SectionId(section_id_counter);
&mut current_subsection_name, if let Some(section) = maybe_section.take() {
&mut maybe_section, sections.insert(new_section_id, section);
); let lookup = section_lookup_tree
.entry(current_section_name.unwrap())
.or_default();
let mut found_node = false;
if let Some(subsection_name) = current_subsection_name {
for node in lookup.iter_mut() {
if let LookupTreeNode::NonTerminal(subsection) = node {
found_node = true;
subsection
.entry(subsection_name)
.or_default()
.push(new_section_id);
break;
}
}
if !found_node {
let mut map = HashMap::new();
map.insert(subsection_name, vec![new_section_id]);
lookup.push(LookupTreeNode::NonTerminal(map));
}
} else {
for node in lookup.iter_mut() {
if let LookupTreeNode::Terminal(vec) = node {
found_node = true;
vec.push(new_section_id);
break;
}
}
if !found_node {
lookup.push(LookupTreeNode::Terminal(vec![new_section_id]))
}
}
section_id_counter += 1;
}
// Initialize new section // Initialize new section
let (name, subname) = (header.name, header.subsection_name); let (name, subname) = (header.name, header.subsection_name);
@ -68,114 +97,46 @@ impl<'a> GitConfig<'a> {
// We need to store the new, current id counter, so don't // We need to store the new, current id counter, so don't
// use new_section_id here and use the already incremented // use new_section_id here and use the already incremented
// section id value. // section id value.
new_self section_header_separators
.section_header_separators .insert(SectionId(section_id_counter), header.separator);
.insert(SectionId(new_self.section_id_counter), header.separator);
} }
e @ Event::Key(_) e @ Event::Key(_) => maybe_section
| e @ Event::Value(_)
| e @ Event::ValueNotDone(_)
| e @ Event::ValueDone(_) => maybe_section
.as_mut() .as_mut()
.expect("Got a section-only event before a section") .expect("Got a section-only event before a section")
.push(e), .push(e),
e @ Event::Comment(_) | e @ Event::Newline(_) | e @ Event::Whitespace(_) => { e @ Event::Value(_) => maybe_section
match maybe_section { .as_mut()
Some(ref mut section) => section.push(e), .expect("Got a section-only event before a section")
None => new_self.front_matter_events.push(e), .push(e),
} e @ Event::Newline(_) => match maybe_section {
} Some(ref mut section) => section.push(e),
None => front_matter_events.push(e),
},
e @ Event::ValueNotDone(_) => maybe_section
.as_mut()
.expect("Got a section-only event before a section")
.push(e),
e @ Event::ValueDone(_) => maybe_section
.as_mut()
.expect("Got a section-only event before a section")
.push(e),
e @ Event::Whitespace(_) => match maybe_section {
Some(ref mut section) => section.push(e),
None => front_matter_events.push(e),
},
} }
} }
// The last section doesn't get pushed since we only push if there's a Self {
// new section header, so we need to call push one more time. front_matter_events,
new_self.push_section( section_lookup_tree,
&mut current_section_name, sections,
&mut current_subsection_name, section_header_separators,
&mut maybe_section, section_id_counter,
);
new_self
}
fn push_section(
&mut self,
current_section_name: &mut Option<&'a str>,
current_subsection_name: &mut Option<&'a str>,
maybe_section: &mut Option<Vec<Event<'a>>>,
) {
let new_section_id = SectionId(self.section_id_counter);
if let Some(section) = maybe_section.take() {
self.sections.insert(new_section_id, section);
let lookup = self
.section_lookup_tree
.entry(current_section_name.unwrap())
.or_default();
let mut found_node = false;
if let Some(subsection_name) = current_subsection_name {
for node in lookup.iter_mut() {
if let LookupTreeNode::NonTerminal(subsection) = node {
found_node = true;
subsection
.entry(subsection_name)
.or_default()
.push(new_section_id);
break;
}
}
if !found_node {
let mut map = HashMap::new();
map.insert(*subsection_name, vec![new_section_id]);
lookup.push(LookupTreeNode::NonTerminal(map));
}
} else {
for node in lookup.iter_mut() {
if let LookupTreeNode::Terminal(vec) = node {
found_node = true;
vec.push(new_section_id);
break;
}
}
if !found_node {
lookup.push(LookupTreeNode::Terminal(vec![new_section_id]))
}
}
self.section_id_counter += 1;
} }
} }
/// Returns an uninterpreted value given a section and optional subsection pub fn get_raw_single_value<'b>(
/// and key.
///
/// Note that `git-config` follows a "last-one-wins" rule for single values.
/// If multiple sections contain the same key, then the last section's last
/// key's value will be returned.
///
/// Concretely, if you have the following config:
///
/// ```text
/// [core]
/// a = b
/// [core]
/// a = c
/// a = d
/// ```
///
/// Then this function will return `d`:
///
/// ```
/// # use serde_git_config::config::GitConfig;
/// # let git_config = GitConfig::from_str("[core]a=b\n[core]\na=c\na=d").unwrap();
/// assert_eq!(git_config.get_raw_value("core", None, "a"), Ok("d"));
/// ```
///
/// # Errors
///
/// This function will return an error if the key is not in the requested
/// section and subsection.
pub fn get_raw_value<'b>(
&self, &self,
section_name: &'b str, section_name: &'b str,
subsection_name: Option<&'b str>, subsection_name: Option<&'b str>,
@ -184,38 +145,33 @@ impl<'a> GitConfig<'a> {
// Note: cannot wrap around the raw_multi_value method because we need // Note: cannot wrap around the raw_multi_value method because we need
// to guarantee that the highest section id is used (so that we follow // to guarantee that the highest section id is used (so that we follow
// the "last one wins" resolution strategy by `git-config`). // the "last one wins" resolution strategy by `git-config`).
let section_id = self.get_section_id_by_name_and_subname(section_name, subsection_name)?; let section_id = self
.get_section_id_by_name_and_subname(section_name, subsection_name)
.ok_or(GitConfigError::SubSectionDoesNotExist(subsection_name))?;
// section_id is guaranteed to exist in self.sections, else we have a // section_id is guaranteed to exist in self.sections, else we have a
// violated invariant. // violated invariant.
let events = self.sections.get(&section_id).unwrap(); let events = self.sections.get(&section_id).unwrap();
let mut found_key = false; let mut found_key = false;
let mut latest_value = None;
for event in events { for event in events {
match event { match event {
Event::Key(event_key) if *event_key == key => found_key = true, Event::Key(event_key) if *event_key == key => found_key = true,
Event::Value(v) if found_key => { Event::Value(v) if found_key => return Ok(v),
found_key = false;
latest_value = Some(*v);
}
_ => (), _ => (),
} }
} }
latest_value.ok_or(GitConfigError::KeyDoesNotExist(key)) Err(GitConfigError::KeyDoesNotExist(key))
} }
fn get_section_id_by_name_and_subname<'b>( fn get_section_id_by_name_and_subname<'b>(
&'a self, &'a self,
section_name: &'b str, section_name: &'b str,
subsection_name: Option<&'b str>, subsection_name: Option<&'b str>,
) -> Result<SectionId, GitConfigError<'b>> { ) -> Option<SectionId> {
self.get_section_ids_by_name_and_subname(section_name, subsection_name) self.get_section_ids_by_name_and_subname(section_name, subsection_name)
.map(|vec| { .map(|vec| vec.into_iter().max())
// get_section_ids_by_name_and_subname is guaranteed to return .flatten()
// a non-empty vec, so max can never return empty.
*vec.into_iter().max().unwrap()
})
} }
pub fn get_raw_multi_value<'b>( pub fn get_raw_multi_value<'b>(
@ -225,33 +181,26 @@ impl<'a> GitConfig<'a> {
key: &'b str, key: &'b str,
) -> Result<Vec<&'a str>, GitConfigError<'b>> { ) -> Result<Vec<&'a str>, GitConfigError<'b>> {
let values = self let values = self
.get_section_ids_by_name_and_subname(section_name, subsection_name)? .get_section_ids_by_name_and_subname(section_name, subsection_name)
.ok_or(GitConfigError::SubSectionDoesNotExist(subsection_name))?
.iter() .iter()
.map(|section_id| { .map(|section_id| {
let mut found_key = false; let mut found_key = false;
let mut events = vec![];
// section_id is guaranteed to exist in self.sections, else we have a // section_id is guaranteed to exist in self.sections, else we have a
// violated invariant. // violated invariant.
for event in self.sections.get(section_id).unwrap() { for event in self.sections.get(section_id).unwrap() {
match event { match event {
Event::Key(event_key) if *event_key == key => found_key = true, Event::Key(event_key) if *event_key == key => found_key = true,
Event::Value(v) if found_key => { Event::Value(v) if found_key => return Ok(*v),
events.push(*v);
found_key = false;
}
_ => (), _ => (),
} }
} }
if events.is_empty() { Err(GitConfigError::KeyDoesNotExist(key))
Err(GitConfigError::KeyDoesNotExist(key))
} else {
Ok(events)
}
}) })
.filter_map(Result::ok) .filter_map(Result::ok)
.flatten()
.collect::<Vec<_>>(); .collect::<Vec<_>>();
if values.is_empty() { if values.is_empty() {
Err(GitConfigError::KeyDoesNotExist(key)) Err(GitConfigError::KeyDoesNotExist(key))
} else { } else {
@ -263,324 +212,32 @@ impl<'a> GitConfig<'a> {
&'a self, &'a self,
section_name: &'b str, section_name: &'b str,
subsection_name: Option<&'b str>, subsection_name: Option<&'b str>,
) -> Result<&[SectionId], GitConfigError<'b>> { ) -> Option<Vec<SectionId>> {
let section_ids = self let section_ids = self.section_lookup_tree.get(section_name)?;
.section_lookup_tree
.get(section_name)
.ok_or(GitConfigError::SectionDoesNotExist(section_name))?;
let mut maybe_ids = None;
// Don't simplify if and matches here -- the for loop currently needs
// `n + 1` checks, while the if and matches will result in the for loop
// needing `2n` checks.
if let Some(subsect_name) = subsection_name { if let Some(subsect_name) = subsection_name {
let mut maybe_ids = None;
for node in section_ids { for node in section_ids {
if let LookupTreeNode::NonTerminal(subsection_lookup) = node { if let LookupTreeNode::NonTerminal(subsection_lookup) = node {
maybe_ids = subsection_lookup.get(subsect_name); maybe_ids = subsection_lookup.get(subsect_name);
break; break;
} }
} }
maybe_ids.map(|vec| vec.clone())
} else { } else {
let mut maybe_ids = None;
for node in section_ids { for node in section_ids {
if let LookupTreeNode::Terminal(subsection_lookup) = node { if let LookupTreeNode::Terminal(subsection_lookup) = node {
maybe_ids = Some(subsection_lookup); maybe_ids = subsection_lookup.iter().max();
break; break;
} }
} }
maybe_ids.map(|v| vec![*v])
} }
maybe_ids
.map(Vec::as_slice)
.ok_or(GitConfigError::SubSectionDoesNotExist(subsection_name))
} }
} }
#[cfg(test)] pub enum GitConfigError<'a> {
mod from_parser { SectionDoesNotExist(&'a str),
use super::*; SubSectionDoesNotExist(Option<&'a str>),
KeyDoesNotExist(&'a str),
#[test]
fn parse_empty() {
let config = GitConfig::from_str("").unwrap();
assert!(config.section_header_separators.is_empty());
assert_eq!(config.section_id_counter, 0);
assert!(config.section_lookup_tree.is_empty());
assert!(config.sections.is_empty());
}
#[test]
fn parse_single_section() {
let config = GitConfig::from_str("[core]\na=b\nc=d").unwrap();
let expected_separators = {
let mut map = HashMap::new();
map.insert(SectionId(0), None);
map
};
assert_eq!(config.section_header_separators, expected_separators);
assert_eq!(config.section_id_counter, 1);
let expected_lookup_tree = {
let mut tree = HashMap::new();
tree.insert("core", vec![LookupTreeNode::Terminal(vec![SectionId(0)])]);
tree
};
assert_eq!(config.section_lookup_tree, expected_lookup_tree);
let expected_sections = {
let mut sections = HashMap::new();
sections.insert(
SectionId(0),
vec![
Event::Newline("\n"),
Event::Key("a"),
Event::Value("b"),
Event::Newline("\n"),
Event::Key("c"),
Event::Value("d"),
],
);
sections
};
assert_eq!(config.sections, expected_sections);
}
#[test]
fn parse_single_subsection() {
let config = GitConfig::from_str("[core.subsec]\na=b\nc=d").unwrap();
let expected_separators = {
let mut map = HashMap::new();
map.insert(SectionId(0), Some("."));
map
};
assert_eq!(config.section_header_separators, expected_separators);
assert_eq!(config.section_id_counter, 1);
let expected_lookup_tree = {
let mut tree = HashMap::new();
let mut inner_tree = HashMap::new();
inner_tree.insert("subsec", vec![SectionId(0)]);
tree.insert("core", vec![LookupTreeNode::NonTerminal(inner_tree)]);
tree
};
assert_eq!(config.section_lookup_tree, expected_lookup_tree);
let expected_sections = {
let mut sections = HashMap::new();
sections.insert(
SectionId(0),
vec![
Event::Newline("\n"),
Event::Key("a"),
Event::Value("b"),
Event::Newline("\n"),
Event::Key("c"),
Event::Value("d"),
],
);
sections
};
assert_eq!(config.sections, expected_sections);
}
#[test]
fn parse_multiple_sections() {
let config = GitConfig::from_str("[core]\na=b\nc=d\n[other]e=f").unwrap();
let expected_separators = {
let mut map = HashMap::new();
map.insert(SectionId(0), None);
map.insert(SectionId(1), None);
map
};
assert_eq!(config.section_header_separators, expected_separators);
assert_eq!(config.section_id_counter, 2);
let expected_lookup_tree = {
let mut tree = HashMap::new();
tree.insert("core", vec![LookupTreeNode::Terminal(vec![SectionId(0)])]);
tree.insert("other", vec![LookupTreeNode::Terminal(vec![SectionId(1)])]);
tree
};
assert_eq!(config.section_lookup_tree, expected_lookup_tree);
let expected_sections = {
let mut sections = HashMap::new();
sections.insert(
SectionId(0),
vec![
Event::Newline("\n"),
Event::Key("a"),
Event::Value("b"),
Event::Newline("\n"),
Event::Key("c"),
Event::Value("d"),
Event::Newline("\n"),
],
);
sections.insert(SectionId(1), vec![Event::Key("e"), Event::Value("f")]);
sections
};
assert_eq!(config.sections, expected_sections);
}
#[test]
fn parse_multiple_duplicate_sections() {
let config = GitConfig::from_str("[core]\na=b\nc=d\n[core]e=f").unwrap();
let expected_separators = {
let mut map = HashMap::new();
map.insert(SectionId(0), None);
map.insert(SectionId(1), None);
map
};
assert_eq!(config.section_header_separators, expected_separators);
assert_eq!(config.section_id_counter, 2);
let expected_lookup_tree = {
let mut tree = HashMap::new();
tree.insert(
"core",
vec![LookupTreeNode::Terminal(vec![SectionId(0), SectionId(1)])],
);
tree
};
assert_eq!(config.section_lookup_tree, expected_lookup_tree);
let expected_sections = {
let mut sections = HashMap::new();
sections.insert(
SectionId(0),
vec![
Event::Newline("\n"),
Event::Key("a"),
Event::Value("b"),
Event::Newline("\n"),
Event::Key("c"),
Event::Value("d"),
Event::Newline("\n"),
],
);
sections.insert(SectionId(1), vec![Event::Key("e"), Event::Value("f")]);
sections
};
assert_eq!(config.sections, expected_sections);
}
}
#[cfg(test)]
mod get_raw_value {
use super::*;
#[test]
fn single_section() {
let config = GitConfig::from_str("[core]\na=b\nc=d").unwrap();
assert_eq!(config.get_raw_value("core", None, "a"), Ok("b"));
assert_eq!(config.get_raw_value("core", None, "c"), Ok("d"));
}
#[test]
fn last_one_wins_respected_in_section() {
let config = GitConfig::from_str("[core]\na=b\na=d").unwrap();
assert_eq!(config.get_raw_value("core", None, "a"), Ok("d"));
}
#[test]
fn last_one_wins_respected_across_section() {
let config = GitConfig::from_str("[core]\na=b\n[core]\na=d").unwrap();
assert_eq!(config.get_raw_value("core", None, "a"), Ok("d"));
}
#[test]
fn section_not_found() {
let config = GitConfig::from_str("[core]\na=b\nc=d").unwrap();
assert_eq!(
config.get_raw_value("foo", None, "a"),
Err(GitConfigError::SectionDoesNotExist("foo"))
);
}
#[test]
fn subsection_not_found() {
let config = GitConfig::from_str("[core]\na=b\nc=d").unwrap();
assert_eq!(
config.get_raw_value("core", Some("a"), "a"),
Err(GitConfigError::SubSectionDoesNotExist(Some("a")))
);
}
#[test]
fn key_not_found() {
let config = GitConfig::from_str("[core]\na=b\nc=d").unwrap();
assert_eq!(
config.get_raw_value("core", None, "aaaaaa"),
Err(GitConfigError::KeyDoesNotExist("aaaaaa"))
);
}
#[test]
fn subsection_must_be_respected() {
let config = GitConfig::from_str("[core]a=b\n[core.a]a=c").unwrap();
assert_eq!(config.get_raw_value("core", None, "a"), Ok("b"));
assert_eq!(config.get_raw_value("core", Some("a"), "a"), Ok("c"));
}
}
#[cfg(test)]
mod get_raw_multi_value {
use super::*;
#[test]
fn single_value_is_identical_to_single_value_query() {
let config = GitConfig::from_str("[core]\na=b\nc=d").unwrap();
assert_eq!(
vec![config.get_raw_value("core", None, "a").unwrap()],
config.get_raw_multi_value("core", None, "a").unwrap()
);
}
#[test]
fn multi_value_in_section() {
let config = GitConfig::from_str("[core]\na=b\na=c").unwrap();
assert_eq!(
config.get_raw_multi_value("core", None, "a").unwrap(),
vec!["b", "c"]
);
}
#[test]
fn multi_value_across_sections() {
let config = GitConfig::from_str("[core]\na=b\na=c\n[core]a=d").unwrap();
assert_eq!(
config.get_raw_multi_value("core", None, "a").unwrap(),
vec!["b", "c", "d"]
);
}
#[test]
fn section_not_found() {
let config = GitConfig::from_str("[core]\na=b\nc=d").unwrap();
assert_eq!(
config.get_raw_multi_value("foo", None, "a"),
Err(GitConfigError::SectionDoesNotExist("foo"))
);
}
#[test]
fn subsection_not_found() {
let config = GitConfig::from_str("[core]\na=b\nc=d").unwrap();
assert_eq!(
config.get_raw_multi_value("core", Some("a"), "a"),
Err(GitConfigError::SubSectionDoesNotExist(Some("a")))
);
}
#[test]
fn key_not_found() {
let config = GitConfig::from_str("[core]\na=b\nc=d").unwrap();
assert_eq!(
config.get_raw_multi_value("core", None, "aaaaaa"),
Err(GitConfigError::KeyDoesNotExist("aaaaaa"))
);
}
#[test]
fn subsection_must_be_respected() {
let config = GitConfig::from_str("[core]a=b\n[core.a]a=c").unwrap();
assert_eq!(
config.get_raw_multi_value("core", None, "a").unwrap(),
vec!["b"]
);
assert_eq!(
config.get_raw_multi_value("core", Some("a"), "a").unwrap(),
vec!["c"]
);
}
} }

877
src/parser.rs
View file

@ -1,19 +1,18 @@
//! This module handles parsing a `git-config`. Generally speaking, you want to //! This module handles parsing a `git-config`. Generally speaking, you want to
//! use a higher abstraction such as [`GitConfig`] unless you have some explicit //! use a higher abstraction unless you have some explicit reason to work with
//! reason to work with events instead. //! events instead.
//! //!
//! The general workflow for interacting with this is to use one of the //! The general workflow for interacting with this is to use one of the
//! `parse_from_*` function variants. These will return a [`Parser`] on success, //! `parse_from_*` function variants. These will return a [`Parser`] on success,
//! which can be converted into an [`Event`] iterator. The [`Parser`] also has //! which can be converted into an [`Event`] iterator. The [`Parser`] also has
//! additional methods for accessing leading comments or events by section. //! additional methods for accessing leading comments or events by section.
//!
//! [`GitConfig`]: crate::config::GitConfig
use nom::bytes::complete::{escaped, tag, take_till, take_while}; use nom::bytes::complete::{escaped, tag, take_till, take_while};
use nom::character::complete::{char, none_of, one_of}; use nom::character::complete::{char, none_of, one_of};
use nom::character::{is_newline, is_space}; use nom::character::{is_newline, is_space};
use nom::combinator::{map, opt}; use nom::combinator::{map, opt};
use nom::error::{Error as NomError, ErrorKind}; use nom::error::{Error as NomError, ErrorKind};
use nom::multi::many1;
use nom::sequence::delimited; use nom::sequence::delimited;
use nom::IResult; use nom::IResult;
use nom::{branch::alt, multi::many0}; use nom::{branch::alt, multi::many0};
@ -361,7 +360,7 @@ impl<'a> Parser<'a> {
/// data succeeding valid `git-config` data. /// data succeeding valid `git-config` data.
pub fn parse_from_str(input: &str) -> Result<Parser<'_>, ParserError> { pub fn parse_from_str(input: &str) -> Result<Parser<'_>, ParserError> {
let (i, comments) = many0(comment)(input)?; let (i, comments) = many0(comment)(input)?;
let (i, sections) = many0(section)(i)?; let (i, sections) = many1(section)(i)?;
if !i.is_empty() { if !i.is_empty() {
return Err(ParserError::ConfigHasExtraData(i)); return Err(ParserError::ConfigHasExtraData(i));
@ -618,475 +617,477 @@ fn take_common<'a, F: Fn(char) -> bool>(i: &'a str, f: F) -> IResult<&'a str, &'
Ok((i, v)) Ok((i, v))
} }
} }
#[cfg(test)] #[cfg(test)]
fn fully_consumed<T>(t: T) -> (&'static str, T) { mod parse {
("", t) use super::*;
}
#[cfg(test)] fn fully_consumed<T>(t: T) -> (&'static str, T) {
fn gen_section_header( ("", t)
name: &str, }
subsection: impl Into<Option<(&'static str, &'static str)>>,
) -> ParsedSectionHeader<'_> { fn gen_section_header(
if let Some((separator, subsection_name)) = subsection.into() { name: &str,
ParsedSectionHeader { subsection: impl Into<Option<(&'static str, &'static str)>>,
name, ) -> ParsedSectionHeader<'_> {
separator: Some(separator), if let Some((separator, subsection_name)) = subsection.into() {
subsection_name: Some(subsection_name), ParsedSectionHeader {
} name,
} else { separator: Some(separator),
ParsedSectionHeader { subsection_name: Some(subsection_name),
name, }
separator: None, } else {
subsection_name: None, ParsedSectionHeader {
name,
separator: None,
subsection_name: None,
}
} }
} }
}
#[cfg(test)] mod comments {
mod comments { use super::super::*;
use super::*; use super::*;
#[test] #[test]
fn semicolon() { fn semicolon() {
assert_eq!( assert_eq!(
comment("; this is a semicolon comment").unwrap(), comment("; this is a semicolon comment").unwrap(),
fully_consumed(ParsedComment { fully_consumed(ParsedComment {
comment_tag: ';', comment_tag: ';',
comment: " this is a semicolon comment", comment: " this is a semicolon comment",
}) })
); );
}
#[test]
fn octothorpe() {
assert_eq!(
comment("# this is an octothorpe comment").unwrap(),
fully_consumed(ParsedComment {
comment_tag: '#',
comment: " this is an octothorpe comment",
})
);
}
#[test]
fn multiple_markers() {
assert_eq!(
comment("###### this is an octothorpe comment").unwrap(),
fully_consumed(ParsedComment {
comment_tag: '#',
comment: "##### this is an octothorpe comment",
})
);
}
} }
#[test] mod section_headers {
fn octothorpe() { use super::super::*;
assert_eq!( use super::*;
comment("# this is an octothorpe comment").unwrap(),
fully_consumed(ParsedComment { #[test]
comment_tag: '#', fn no_subsection() {
comment: " this is an octothorpe comment", assert_eq!(
}) section_header("[hello]").unwrap(),
); fully_consumed(gen_section_header("hello", None)),
);
}
#[test]
fn modern_subsection() {
assert_eq!(
section_header(r#"[hello "world"]"#).unwrap(),
fully_consumed(gen_section_header("hello", (" ", "world"))),
);
}
#[test]
fn escaped_subsection() {
assert_eq!(
section_header(r#"[hello "foo\\bar\""]"#).unwrap(),
fully_consumed(gen_section_header("hello", (" ", r#"foo\\bar\""#))),
);
}
#[test]
fn deprecated_subsection() {
assert_eq!(
section_header(r#"[hello.world]"#).unwrap(),
fully_consumed(gen_section_header("hello", (".", "world")))
);
}
#[test]
fn empty_legacy_subsection_name() {
assert_eq!(
section_header(r#"[hello.]"#).unwrap(),
fully_consumed(gen_section_header("hello", (".", "")))
);
}
#[test]
fn empty_modern_subsection_name() {
assert_eq!(
section_header(r#"[hello ""]"#).unwrap(),
fully_consumed(gen_section_header("hello", (" ", "")))
);
}
#[test]
fn newline_in_header() {
assert!(section_header("[hello\n]").is_err())
}
#[test]
fn null_byte_in_header() {
assert!(section_header("[hello\0]").is_err())
}
#[test]
fn right_brace_in_subsection_name() {
assert_eq!(
section_header(r#"[hello "]"]"#).unwrap(),
fully_consumed(gen_section_header("hello", (" ", "]")))
);
}
} }
#[test] mod config_name {
fn multiple_markers() { use super::super::*;
assert_eq!( use super::*;
comment("###### this is an octothorpe comment").unwrap(),
fully_consumed(ParsedComment {
comment_tag: '#',
comment: "##### this is an octothorpe comment",
})
);
}
}
#[cfg(test)] #[test]
mod section_headers { fn just_name() {
use super::*; assert_eq!(config_name("name").unwrap(), fully_consumed("name"));
}
#[test] #[test]
fn no_subsection() { fn must_start_with_alphabetic() {
assert_eq!( assert!(config_name("4aaa").is_err());
section_header("[hello]").unwrap(), assert!(config_name("-aaa").is_err());
fully_consumed(gen_section_header("hello", None)), }
);
#[test]
fn cannot_be_empty() {
assert!(config_name("").is_err())
}
} }
#[test] mod value_no_continuation {
fn modern_subsection() { use super::super::*;
assert_eq!( use super::*;
section_header(r#"[hello "world"]"#).unwrap(),
fully_consumed(gen_section_header("hello", (" ", "world"))),
);
}
#[test] #[test]
fn escaped_subsection() { fn no_comment() {
assert_eq!( assert_eq!(
section_header(r#"[hello "foo\\bar\""]"#).unwrap(), value_impl("hello").unwrap(),
fully_consumed(gen_section_header("hello", (" ", r#"foo\\bar\""#))), fully_consumed(vec![Event::Value("hello")])
); );
} }
#[test] #[test]
fn deprecated_subsection() { fn no_comment_newline() {
assert_eq!( assert_eq!(
section_header(r#"[hello.world]"#).unwrap(), value_impl("hello\na").unwrap(),
fully_consumed(gen_section_header("hello", (".", "world"))) ("\na", vec![Event::Value("hello")])
);
}
#[test]
fn empty_legacy_subsection_name() {
assert_eq!(
section_header(r#"[hello.]"#).unwrap(),
fully_consumed(gen_section_header("hello", (".", "")))
);
}
#[test]
fn empty_modern_subsection_name() {
assert_eq!(
section_header(r#"[hello ""]"#).unwrap(),
fully_consumed(gen_section_header("hello", (" ", "")))
);
}
#[test]
fn newline_in_header() {
assert!(section_header("[hello\n]").is_err())
}
#[test]
fn null_byte_in_header() {
assert!(section_header("[hello\0]").is_err())
}
#[test]
fn right_brace_in_subsection_name() {
assert_eq!(
section_header(r#"[hello "]"]"#).unwrap(),
fully_consumed(gen_section_header("hello", (" ", "]")))
);
}
}
#[cfg(test)]
mod config_name {
use super::*;
#[test]
fn just_name() {
assert_eq!(config_name("name").unwrap(), fully_consumed("name"));
}
#[test]
fn must_start_with_alphabetic() {
assert!(config_name("4aaa").is_err());
assert!(config_name("-aaa").is_err());
}
#[test]
fn cannot_be_empty() {
assert!(config_name("").is_err())
}
}
#[cfg(test)]
mod value_no_continuation {
use super::*;
#[test]
fn no_comment() {
assert_eq!(
value_impl("hello").unwrap(),
fully_consumed(vec![Event::Value("hello")])
);
}
#[test]
fn no_comment_newline() {
assert_eq!(
value_impl("hello\na").unwrap(),
("\na", vec![Event::Value("hello")])
)
}
#[test]
fn semicolon_comment_not_consumed() {
assert_eq!(
value_impl("hello;world").unwrap(),
(";world", vec![Event::Value("hello"),])
);
}
#[test]
fn octothorpe_comment_not_consumed() {
assert_eq!(
value_impl("hello#world").unwrap(),
("#world", vec![Event::Value("hello"),])
);
}
#[test]
fn values_with_extraneous_whitespace_without_comment() {
assert_eq!(
value_impl("hello ").unwrap(),
(" ", vec![Event::Value("hello")])
);
}
#[test]
fn values_with_extraneous_whitespace_before_comment() {
assert_eq!(
value_impl("hello #world").unwrap(),
(" #world", vec![Event::Value("hello"),])
);
assert_eq!(
value_impl("hello ;world").unwrap(),
(" ;world", vec![Event::Value("hello"),])
);
}
#[test]
fn trans_escaped_comment_marker_not_consumed() {
assert_eq!(
value_impl(r##"hello"#"world; a"##).unwrap(),
("; a", vec![Event::Value(r##"hello"#"world"##)])
);
}
#[test]
fn complex_test() {
assert_eq!(
value_impl(r#"value";";ahhhh"#).unwrap(),
(";ahhhh", vec![Event::Value(r#"value";""#)])
);
}
#[test]
fn garbage_after_continution_is_err() {
assert!(value_impl("hello \\afwjdls").is_err());
}
}
#[cfg(test)]
mod value_continuation {
use super::*;
#[test]
fn simple_continuation() {
assert_eq!(
value_impl("hello\\\nworld").unwrap(),
fully_consumed(vec![
Event::ValueNotDone("hello"),
Event::Newline("\n"),
Event::ValueDone("world")
])
);
}
#[test]
fn continuation_with_whitespace() {
assert_eq!(
value_impl("hello\\\n world").unwrap(),
fully_consumed(vec![
Event::ValueNotDone("hello"),
Event::Newline("\n"),
Event::ValueDone(" world")
])
)
}
#[test]
fn complex_continuation_with_leftover_comment() {
assert_eq!(
value_impl("1 \"\\\"\\\na ; e \"\\\"\\\nd # \"b\t ; c").unwrap(),
(
" # \"b\t ; c",
vec![
Event::ValueNotDone(r#"1 "\""#),
Event::Newline("\n"),
Event::ValueNotDone(r#"a ; e "\""#),
Event::Newline("\n"),
Event::ValueDone("d"),
]
) )
); }
#[test]
fn semicolon_comment_not_consumed() {
assert_eq!(
value_impl("hello;world").unwrap(),
(";world", vec![Event::Value("hello"),])
);
}
#[test]
fn octothorpe_comment_not_consumed() {
assert_eq!(
value_impl("hello#world").unwrap(),
("#world", vec![Event::Value("hello"),])
);
}
#[test]
fn values_with_extraneous_whitespace_without_comment() {
assert_eq!(
value_impl("hello ").unwrap(),
(" ", vec![Event::Value("hello")])
);
}
#[test]
fn values_with_extraneous_whitespace_before_comment() {
assert_eq!(
value_impl("hello #world").unwrap(),
(" #world", vec![Event::Value("hello"),])
);
assert_eq!(
value_impl("hello ;world").unwrap(),
(" ;world", vec![Event::Value("hello"),])
);
}
#[test]
fn trans_escaped_comment_marker_not_consumed() {
assert_eq!(
value_impl(r##"hello"#"world; a"##).unwrap(),
("; a", vec![Event::Value(r##"hello"#"world"##)])
);
}
#[test]
fn complex_test() {
assert_eq!(
value_impl(r#"value";";ahhhh"#).unwrap(),
(";ahhhh", vec![Event::Value(r#"value";""#)])
);
}
#[test]
fn garbage_after_continution_is_err() {
assert!(value_impl("hello \\afwjdls").is_err());
}
} }
#[test] mod value_continuation {
fn quote_split_over_two_lines_with_leftover_comment() { use super::super::*;
assert_eq!( use super::*;
value_impl("\"\\\n;\";a").unwrap(),
( #[test]
";a", fn simple_continuation() {
vec![ assert_eq!(
Event::ValueNotDone("\""), value_impl("hello\\\nworld").unwrap(),
fully_consumed(vec![
Event::ValueNotDone("hello"),
Event::Newline("\n"), Event::Newline("\n"),
Event::ValueDone(";\""), Event::ValueDone("world")
] ])
);
}
#[test]
fn continuation_with_whitespace() {
assert_eq!(
value_impl("hello\\\n world").unwrap(),
fully_consumed(vec![
Event::ValueNotDone("hello"),
Event::Newline("\n"),
Event::ValueDone(" world")
])
) )
) }
}
}
#[cfg(test)] #[test]
mod section { fn complex_continuation_with_leftover_comment() {
use super::*; assert_eq!(
value_impl("1 \"\\\"\\\na ; e \"\\\"\\\nd # \"b\t ; c").unwrap(),
(
" # \"b\t ; c",
vec![
Event::ValueNotDone(r#"1 "\""#),
Event::Newline("\n"),
Event::ValueNotDone(r#"a ; e "\""#),
Event::Newline("\n"),
Event::ValueDone("d"),
]
)
);
}
#[test] #[test]
fn empty_section() { fn quote_split_over_two_lines_with_leftover_comment() {
assert_eq!( assert_eq!(
section("[test]").unwrap(), value_impl("\"\\\n;\";a").unwrap(),
fully_consumed(ParsedSection { (
section_header: gen_section_header("test", None), ";a",
events: vec![] vec![
}) Event::ValueNotDone("\""),
); Event::Newline("\n"),
Event::ValueDone(";\""),
]
)
)
}
} }
#[test] mod section {
fn simple_section() { use super::super::*;
let section_data = r#"[hello] use super::*;
#[test]
fn empty_section() {
assert_eq!(
section("[test]").unwrap(),
fully_consumed(ParsedSection {
section_header: gen_section_header("test", None),
events: vec![]
})
);
}
#[test]
fn simple_section() {
let section_data = r#"[hello]
a = b a = b
c c
d = "lol""#; d = "lol""#;
assert_eq!( assert_eq!(
section(section_data).unwrap(), section(section_data).unwrap(),
fully_consumed(ParsedSection { fully_consumed(ParsedSection {
section_header: gen_section_header("hello", None), section_header: gen_section_header("hello", None),
events: vec![ events: vec![
Event::Newline("\n"), Event::Newline("\n"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Key("a"), Event::Key("a"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Value("b"), Event::Value("b"),
Event::Newline("\n"), Event::Newline("\n"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Key("c"), Event::Key("c"),
Event::Value(""), Event::Value(""),
Event::Newline("\n"), Event::Newline("\n"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Key("d"), Event::Key("d"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Value("\"lol\"") Event::Value("\"lol\"")
] ]
}) })
) )
} }
#[test] #[test]
fn section_single_line() { fn section_single_line() {
assert_eq!( assert_eq!(
section("[hello] c").unwrap(), section("[hello] c").unwrap(),
fully_consumed(ParsedSection { fully_consumed(ParsedSection {
section_header: gen_section_header("hello", None), section_header: gen_section_header("hello", None),
events: vec![Event::Whitespace(" "), Event::Key("c"), Event::Value("")] events: vec![Event::Whitespace(" "), Event::Key("c"), Event::Value("")]
}) })
); );
} }
#[test] #[test]
fn section_very_commented() { fn section_very_commented() {
let section_data = r#"[hello] ; commentA let section_data = r#"[hello] ; commentA
a = b # commentB a = b # commentB
; commentC ; commentC
; commentD ; commentD
c = d"#; c = d"#;
assert_eq!( assert_eq!(
section(section_data).unwrap(), section(section_data).unwrap(),
fully_consumed(ParsedSection { fully_consumed(ParsedSection {
section_header: gen_section_header("hello", None), section_header: gen_section_header("hello", None),
events: vec![ events: vec![
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Comment(ParsedComment { Event::Comment(ParsedComment {
comment_tag: ';', comment_tag: ';',
comment: " commentA", comment: " commentA",
}), }),
Event::Newline("\n"), Event::Newline("\n"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Key("a"), Event::Key("a"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Value("b"), Event::Value("b"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Comment(ParsedComment { Event::Comment(ParsedComment {
comment_tag: '#', comment_tag: '#',
comment: " commentB", comment: " commentB",
}), }),
Event::Newline("\n"), Event::Newline("\n"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Comment(ParsedComment { Event::Comment(ParsedComment {
comment_tag: ';', comment_tag: ';',
comment: " commentC", comment: " commentC",
}), }),
Event::Newline("\n"), Event::Newline("\n"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Comment(ParsedComment { Event::Comment(ParsedComment {
comment_tag: ';', comment_tag: ';',
comment: " commentD", comment: " commentD",
}), }),
Event::Newline("\n"), Event::Newline("\n"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Key("c"), Event::Key("c"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Value("d"), Event::Value("d"),
] ]
}) })
); );
} }
#[test] #[test]
fn complex_continuation() { fn complex_continuation() {
// This test is absolute hell. Good luck if this fails. // This test is absolute hell. Good luck if this fails.
assert_eq!( assert_eq!(
section("[section] a = 1 \"\\\"\\\na ; e \"\\\"\\\nd # \"b\t ; c").unwrap(), section("[section] a = 1 \"\\\"\\\na ; e \"\\\"\\\nd # \"b\t ; c").unwrap(),
fully_consumed(ParsedSection { fully_consumed(ParsedSection {
section_header: gen_section_header("section", None), section_header: gen_section_header("section", None),
events: vec![ events: vec![
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Key("a"), Event::Key("a"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::ValueNotDone(r#"1 "\""#), Event::ValueNotDone(r#"1 "\""#),
Event::Newline("\n"), Event::Newline("\n"),
Event::ValueNotDone(r#"a ; e "\""#), Event::ValueNotDone(r#"a ; e "\""#),
Event::Newline("\n"), Event::Newline("\n"),
Event::ValueDone("d"), Event::ValueDone("d"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Comment(ParsedComment { Event::Comment(ParsedComment {
comment_tag: '#', comment_tag: '#',
comment: " \"b\t ; c" comment: " \"b\t ; c"
}) })
] ]
}) })
); );
} }
#[test] #[test]
fn quote_split_over_two_lines() { fn quote_split_over_two_lines() {
assert_eq!( assert_eq!(
section("[section \"a\"] b =\"\\\n;\";a").unwrap(), section("[section \"a\"] b =\"\\\n;\";a").unwrap(),
fully_consumed(ParsedSection { fully_consumed(ParsedSection {
section_header: gen_section_header("section", (" ", "a")), section_header: gen_section_header("section", (" ", "a")),
events: vec![ events: vec![
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Key("b"), Event::Key("b"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::ValueNotDone("\""), Event::ValueNotDone("\""),
Event::Newline("\n"), Event::Newline("\n"),
Event::ValueDone(";\""), Event::ValueDone(";\""),
Event::Comment(ParsedComment { Event::Comment(ParsedComment {
comment_tag: ';', comment_tag: ';',
comment: "a", comment: "a",
}) })
] ]
}) })
) )
} }
#[test] #[test]
fn section_handles_extranous_whitespace_before_comment() { fn section_handles_extranous_whitespace_before_comment() {
assert_eq!( assert_eq!(
section("[s]hello #world").unwrap(), section("[s]hello #world").unwrap(),
fully_consumed(ParsedSection { fully_consumed(ParsedSection {
section_header: gen_section_header("s", None), section_header: gen_section_header("s", None),
events: vec![ events: vec![
Event::Key("hello"), Event::Key("hello"),
Event::Whitespace(" "), Event::Whitespace(" "),
Event::Value(""), Event::Value(""),
Event::Comment(ParsedComment { Event::Comment(ParsedComment {
comment_tag: '#', comment_tag: '#',
comment: "world", comment: "world",
}), }),
] ]
}) })
); );
}
} }
} }

8
tests/parser_integration_tests.rs
View file

@ -62,7 +62,8 @@ fn personal_config() {
assert_eq!( assert_eq!(
parse_from_str(config) parse_from_str(config)
.unwrap() .unwrap()
.into_vec(), .into_iter()
.collect::<Vec<_>>(),
vec![ vec![
gen_section_header("user", None), gen_section_header("user", None),
newline(), newline(),
@ -162,8 +163,3 @@ fn personal_config() {
] ]
); );
} }
#[test]
fn parse_empty() {
assert_eq!(parse_from_str("").unwrap().into_vec(), vec![]);
}