fix-getters-utils 0.3.2

Utils for fix-getters
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

//! `Getter` helper.

#[cfg(feature = "log")]
use log::{debug, trace};

use std::{
    error::Error,
    fmt::{self, Display},
    path::Path,
};

use rules::{self, NewName, RenameError, ReturnsBool};

/// `Getter` helper.
///
/// A `Getter` is a function for which the renaming rules defined in crate
/// [`fix-getters-rules`](../../fix_getters_rules/function/index.html) hold.
#[derive(Debug)]
pub struct Getter {
    pub name: String,
    pub new_name: NewName,
    pub line: usize,
}

#[derive(Debug)]
pub struct GetterError {
    pub name: String,
    pub err: RenameError,
    pub line: usize,
}

impl GetterError {
    /// Logs details about the getter creation failure at the appropriate log level.
    #[cfg(feature = "log")]
    pub fn log(&self, scope: &dyn Display) {
        if !self.err.is_not_get_fn() {
            debug!("* {} {}", scope, self);
        } else {
            trace!("* {} {}", scope, self);
        }
    }
}

impl Display for GetterError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "@ {}: skipping {}() {}", self.line, self.name, self.err)
    }
}

impl Error for GetterError {}

impl Getter {
    /// Attempts to build a `Getter` from the provided data.
    pub fn try_new(
        name: String,
        returns_bool: impl Into<ReturnsBool> + Copy,
        line: usize,
    ) -> Result<Self, GetterError> {
        match rules::try_rename_would_be_getter(&name, returns_bool) {
            Ok(new_name) => Ok(Getter {
                name,
                new_name,
                line,
            }),
            Err(err) => Err(GetterError { name, err, line }),
        }
    }

    pub fn returns_bool(&self) -> ReturnsBool {
        self.new_name.returns_bool()
    }

    pub fn set_returns_bool(&mut self, returns_bool: impl Into<ReturnsBool>) {
        let returns_bool = returns_bool.into();
        if self.new_name.returns_bool() != returns_bool {
            self.new_name = rules::try_rename_would_be_getter(&self.name, returns_bool)
                .expect("conformity already checked");
        }
    }

    /// Logs details about the getter at the appropriate log level.
    #[cfg(feature = "log")]
    pub fn log(&self, _path: &Path, scope: &dyn Display) {
        if self.new_name.is_regular() {
            trace!("* {} {}", scope, self);
        } else {
            debug!("* {} {}", scope, self);
        }
    }
}

impl Display for Getter {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "@ {}: {}() {}()", self.line, self.name, self.new_name,)
    }
}

/// Logs the reason for skipping the `name` function.
#[cfg(feature = "log")]
pub fn skip(scope: &dyn Display, name: &str, reason: &dyn Display, line: usize) {
    debug!("* {} @ {}: skipping {}() {}", scope, line, name, reason);
}

/// Reason for considering a function is not a getter.
#[derive(Debug, PartialEq)]
#[non_exhaustive]
pub enum NonGetterReason {
    GenericTypeParam,
    MultipleArgs,
    NotAGet,
    NotAMethod,
    NonSelfUniqueArg,
    NoArgs,
}

impl Display for NonGetterReason {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        use NonGetterReason::*;
        match self {
            GenericTypeParam => f.write_str("generic type parameter(s)"),
            MultipleArgs => f.write_str("multiple arguments (incl. self)"),
            NotAGet => f.write_str("not a get function"),
            NotAMethod => f.write_str("not a method"),
            NonSelfUniqueArg => f.write_str("unique argument is not self"),
            NoArgs => f.write_str("no arguments"),
        }
    }
}