indent/
lib.rs

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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
// SPDX-FileCopyrightText: 2021 ilkecan <ilkecan@protonmail.com>
//
// SPDX-License-Identifier: MPL-2.0

//! These functions are useful for inserting a multiline string into an already indented context in
//! another string.

use std::borrow::Cow;

/// Indents every line that is not empty by the given number of spaces, starting from the second
/// line.
///
/// The first line of the string is not indented so that it can be placed after an introduction
/// sequence that has already begun the line.
///
/// # Examples
/// ```rust
/// assert_eq!(format!("  items: {}", indent::indent_by(2, "[\n  foo,\n  bar,\n]\n")),
/// "  items: [
///     foo,
///     bar,
///   ]
/// ")
/// ```
///
/// For the version that also indents the first line, see [indent_all_by].
pub fn indent_by<'a, S>(number_of_spaces: usize, input: S) -> String
where
    S: Into<Cow<'a, str>>,
{
    indent(" ".repeat(number_of_spaces), input, false)
}

/// Indents every line that is not empty with the given prefix, starting from the second line.
///
/// The first line of the string is not indented so that it can be placed after an introduction
/// sequence that has already begun the line.
///
/// # Examples
/// ```rust
/// assert_eq!(format!("items:{}", indent::indent_with("- ", "\nfoo\nbar\n")),
/// "items:
/// - foo
/// - bar
/// ")
/// ```
///
/// For the version that also indents the first line, see [indent_all_with].
pub fn indent_with<'a, S, T>(prefix: S, input: T) -> String
where
    S: Into<Cow<'a, str>>,
    T: Into<Cow<'a, str>>,
{
    indent(prefix, input, false)
}

/// Indents every line that is not empty by the given number of spaces.
///
/// # Examples
/// ```rust
/// assert_eq!(format!("items: [\n{}]\n", indent::indent_all_by(2, "foo,\nbar,\n")),
/// "items: [
///   foo,
///   bar,
/// ]
/// ")
/// ```
///
/// For the version that doesn't indent the first line, see [indent_by].
pub fn indent_all_by<'a, S>(number_of_spaces: usize, input: S) -> String
where
    S: Into<Cow<'a, str>>,
{
    indent(" ".repeat(number_of_spaces), input, true)
}

/// Indents every line that is not empty with the given prefix.
///
/// # Examples
/// ```rust
/// assert_eq!(format!("items:\n{}", indent::indent_all_with("- ", "foo\nbar\n")),
/// "items:
/// - foo
/// - bar
/// ")
/// ```
///
/// For the version that also indents the first line, see [indent_with].
pub fn indent_all_with<'a, S, T>(prefix: S, input: T) -> String
where
    S: Into<Cow<'a, str>>,
    T: Into<Cow<'a, str>>,
{
    indent(prefix, input, true)
}

fn indent<'a, S, T>(prefix: S, input: T, indent_all: bool) -> String
where
    S: Into<Cow<'a, str>>,
    T: Into<Cow<'a, str>>,
{
    let prefix = prefix.into();
    let input = input.into();
    let length = input.len();
    let mut output = String::with_capacity(length + length / 2);

    for (i, line) in input.lines().enumerate() {
        if i > 0 {
            output.push('\n');

            if !line.is_empty() {
                output.push_str(&prefix);
            }
        } else if indent_all && !line.is_empty() {
            output.push_str(&prefix);
        }

        output.push_str(line);
    }

    if input.ends_with('\n') {
        output.push('\n');
    }

    output
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_single_line_without_newline() {
        assert_eq!(indent_by(2, "foo"), "foo")
    }

    #[test]
    fn test_single_line_with_newline() {
        assert_eq!(indent_by(2, "foo\n"), "foo\n")
    }

    #[test]
    fn test_multiline_without_newline() {
        assert_eq!(
            indent_by(
                2, "
foo
bar"
            ),
            "
  foo
  bar"
        )
    }

    #[test]
    fn test_multiline_with_newline() {
        assert_eq!(
            indent_by(
                2,
                "
foo
bar
"
            ),
            "
  foo
  bar
"
        )
    }

    #[test]
    fn test_empty_line() {
        assert_eq!(
            indent_by(
                2,
                "
foo

bar
"
            ),
            "
  foo

  bar
"
        )
    }

    #[test]
    fn test_indent_all_by_empty_line() {
        assert_eq!(
            indent_all_by(
                2,
                "
foo

bar"
            ),
            "
  foo

  bar"
        )
    }

    #[test]
    fn test_indent_all_by() {
        assert_eq!(
            indent_all_by(
                2, "foo

bar"
            ),
            "  foo

  bar"
        )
    }

    #[test]
    fn test_indent_with() {
        assert_eq!(
            indent_with(
                "  ",
                "
foo

bar
"
            ),
            "
  foo

  bar
"
        )
    }

    #[test]
    fn test_indent_all_with() {
        assert_eq!(
            indent_all_with(
                "  ", "foo

bar"
            ),
            "  foo

  bar"
        )
    }
}