ploys 0.6.0

A utility to manage projects, packages, releases and deployments.
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
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

//! Project Configuration
//!
//! This module includes the project configuration file format that is based on
//! the TOML file format.

mod error;
mod project;

use std::fmt::{self, Display};
use std::str::FromStr;

use toml_edit::{DocumentMut, Item, Table, value};

use crate::repository::RepoSpec;

pub use self::error::Error;
pub use self::project::{Project, ProjectMut};

/// The project configuration.
#[derive(Clone, Debug)]
pub struct Config(DocumentMut);

impl Config {
    /// Creates a new project config.
    pub fn new(name: impl Into<String>) -> Self {
        let mut document = DocumentMut::new();

        document.insert(
            "project",
            Item::Table({
                let mut table = Table::new();

                table.insert("name", value(name.into()));
                table
            }),
        );

        Self(document)
    }

    /// Gets the project name.
    pub fn project_name(&self) -> &str {
        self.project().name()
    }

    /// Gets the project description.
    pub fn project_description(&self) -> Option<&str> {
        self.project().description()
    }

    /// Sets the project description.
    pub fn set_project_description(&mut self, description: impl Into<String>) -> &mut Self {
        self.project_mut().set_description(description);
        self
    }

    /// Builds the config with the given project description.
    pub fn with_project_description(mut self, description: impl Into<String>) -> Self {
        self.set_project_description(description);
        self
    }

    /// Gets the project repository.
    pub fn project_repository(&self) -> Option<RepoSpec> {
        self.project().repository()
    }

    /// Sets the project repository.
    pub fn set_project_repository(&mut self, repository: impl Into<RepoSpec>) -> &mut Self {
        self.project_mut().set_repository(repository);
        self
    }

    /// Builds the config with the given project repository.
    pub fn with_project_repository(mut self, repository: impl Into<RepoSpec>) -> Self {
        self.set_project_repository(repository);
        self
    }

    /// Gets the project authors.
    pub fn project_authors(&self) -> impl Iterator<Item = &str> {
        self.project().authors()
    }

    /// Sets the project authors.
    pub fn set_project_authors(&mut self, authors: impl IntoIterator<Item = String>) -> &mut Self {
        self.project_mut().set_authors(authors);
        self
    }

    /// Builds the config with the given project authors.
    pub fn with_project_authors(mut self, authors: impl IntoIterator<Item = String>) -> Self {
        self.set_project_authors(authors);
        self
    }

    /// The project section.
    pub fn project(&self) -> Project<'_> {
        Project::from_table(
            self.0
                .get("project")
                .and_then(Item::as_table_like)
                .expect("project"),
        )
        .expect("project table")
    }

    /// The mutable project section.
    pub fn project_mut(&mut self) -> ProjectMut<'_> {
        ProjectMut::from_table(
            self.0
                .get_mut("project")
                .and_then(Item::as_table_like_mut)
                .expect("project"),
        )
        .expect("project table")
    }
}

impl Config {
    /// Constructs config from the given bytes.
    pub(crate) fn from_bytes(bytes: &[u8]) -> Result<Self, Error> {
        std::str::from_utf8(bytes)?.parse()
    }
}

impl Display for Config {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Display::fmt(&self.0, f)
    }
}

impl PartialEq for Config {
    fn eq(&self, other: &Self) -> bool {
        self.0.to_string() == other.0.to_string()
    }
}

impl Eq for Config {}

impl FromStr for Config {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let document: DocumentMut = s.parse()?;

        Project::from_table(
            document
                .get("project")
                .and_then(Item::as_table_like)
                .ok_or(Error::Invalid)?,
        )
        .ok_or(Error::Invalid)?;

        Ok(Self(document))
    }
}

#[cfg(test)]
mod tests {
    use crate::repository::RepoSpec;

    use super::Config;

    #[test]
    fn test_builder() {
        let config = Config::new("example")
            .with_project_description("An example project.")
            .with_project_repository("ploys/example".parse::<RepoSpec>().unwrap());

        assert_eq!(config.project_name(), "example");
        assert_eq!(config.project_description().unwrap(), "An example project.");
        assert_eq!(
            config.project_repository().unwrap(),
            "ploys/example".parse::<RepoSpec>().unwrap()
        );

        let expected = indoc::indoc! {r#"
            [project]
            name = "example"
            description = "An example project."
            repository = "ploys/example"
        "#};

        assert_eq!(config.to_string(), expected);
    }
}