devrc 0.6.0

devrc is an easy to use task runner tool on steroids for developers
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

use std::{cmp::Ordering, convert::TryFrom};

use devrc_core::workshop::Designer;
use serde::Deserialize;

use crate::errors::{DevrcError, DevrcResult};

use super::params_parser::parse_params_string;

#[derive(Debug, Deserialize, Clone, PartialEq, Eq)]
pub struct ComplexParam {
    pub default: Option<String>,
    pub desc: Option<String>,
}

#[derive(Debug, Deserialize, Clone, PartialEq, Eq)]
#[serde(untagged)]
pub enum ParamValue {
    Required,
    Default(String),
    // Complex(ComplexParam),
}

#[derive(Debug, Deserialize, Clone, PartialEq, Eq)]
pub struct Params {
    #[serde(flatten)]
    pub params: indexmap::IndexMap<String, ParamValue>,
}

impl Params {
    pub fn add(&mut self, key: &str, value: &ParamValue) -> DevrcResult<()> {
        self.params.insert(key.to_string(), value.to_owned());

        Ok(())
    }

    pub fn update(&mut self, params: Params) -> DevrcResult<()> {
        for (key, value) in params.params.iter() {
            self.add(key, value)?;
        }
        Ok(())
    }

    pub fn sort(&mut self) -> DevrcResult<()> {
        self.params.sort_by(|_, v1, _, v2| match (v1, v2) {
            (ParamValue::Required, ParamValue::Required) => Ordering::Equal,
            (ParamValue::Required, ParamValue::Default(_)) => Ordering::Less,
            (ParamValue::Default(_), ParamValue::Required) => Ordering::Greater,
            (ParamValue::Default(_), ParamValue::Default(_)) => Ordering::Equal,
        });

        // self.params = sorted;

        Ok(())
    }

    pub fn merge(&mut self, mut params: Params) -> DevrcResult<()> {
        // Parametes from `params` have priority over
        // parameters from task name

        for (key, value) in self.params.iter() {
            if params.params.contains_key(key) {
                // There are parameters name which are cpecified
                // in task name and params key
                return Err(DevrcError::OverlappingParameters);
            }
            params.add(key, value)?;
        }

        self.params = params.params;

        self.sort()?;

        Ok(())
    }

    pub fn format_help_string(&self, designer: &Designer) -> DevrcResult<String> {
        let mut parts = Vec::new();

        for (key, value) in self.params.iter() {
            match value {
                ParamValue::Required => parts.push(format!(
                    "{}{}{}",
                    designer.parameter_name().prefix(),
                    key,
                    designer.parameter_name().suffix()
                )),
                ParamValue::Default(default) => {
                    let help = format!(
                        "{}{}{}=\"{}{}{}\"",
                        designer.parameter_name().prefix(),
                        key,
                        designer.parameter_name().suffix(),
                        designer.parameter_value().prefix(),
                        default,
                        designer.parameter_value().suffix()
                    );

                    parts.push(help)
                }
            }
        }

        Ok(parts.join(" "))
    }

    // pub fn evaluate(&self, parent_scope: &Scope) -> DevrcResult<indexmap::IndexMap<String, String>>{
    //     let mut local_scope = parent_scope.clone();
    //     let mut vars = indexmap::IndexMap::new();
    //     for (key, value) in &self.params {
    //         match value.evaluate(&key, &local_scope) {
    //             Ok(value) => {
    //                 local_scope.insert_var(&key, &value);
    //                 vars.insert(key.clone(), value)
    //             }
    //             Err(error) => return Err(error),
    //         };
    //     }
    //     Ok(vars)
    // }
}

impl TryFrom<String> for Params {
    type Error = DevrcError;

    fn try_from(value: String) -> DevrcResult<Self> {
        parse_params_string(&value)
    }
}

impl Default for Params {
    fn default() -> Self {
        let params = indexmap::IndexMap::new();
        Self { params }
    }
}