irename 0.1.6

interactive file renaming tool
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
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
use crate::path_utils;

use std::{fmt::Display, path::PathBuf, str::FromStr, thread, time::Duration};

use lazy_static::lazy_static;
use num_derive::{FromPrimitive, ToPrimitive};
use regex::Regex;
use termion::{event::Key, input::TermRead};
use tui::{
    backend::Backend,
    layout::{Constraint, Direction, Layout, Margin},
    style::{Color, Modifier, Style},
    text::{Span, Spans},
    widgets::{Block, Borders, Paragraph, Wrap},
    Frame, Terminal,
};
use variant_count::VariantCount;

bitflags::bitflags! {
    struct MatchFlags : u8 {
        const NO_FLAGS = 0;
        const GLOBAL = 1;
        const ICASE = 2;
    }
}

impl Display for MatchFlags {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        if self.contains(MatchFlags::GLOBAL) {
            f.write_str("g")?;
        }
        if self.contains(MatchFlags::ICASE) {
            f.write_str("i")?;
        }

        Ok(())
    }
}

lazy_static! {
    static ref FLAGS_REGEX: Regex = Regex::new("[gi]{0,2}").unwrap();
}

impl FromStr for MatchFlags {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        if FLAGS_REGEX.is_match(s) {
            let mut flags = MatchFlags::NO_FLAGS;
            if s.contains('g') {
                flags |= MatchFlags::GLOBAL;
            }
            if s.contains('i') {
                flags |= MatchFlags::ICASE;
            }
            Ok(flags)
        } else {
            Err(format!("invalid regex flags: '{}'", s))
        }
    }
}

#[derive(Debug, PartialEq, FromPrimitive, ToPrimitive, VariantCount)]
enum EditableArea {
    Regex,
    Replace,
}

impl EditableArea {
    fn next(&self) -> Self {
        let num_value = num::ToPrimitive::to_usize(self).unwrap();
        let next_value = (num_value.overflowing_add(1).0) % EditableArea::VARIANT_COUNT;

        num::FromPrimitive::from_usize(next_value).unwrap()
    }

    fn prev(&self) -> Self {
        let num_value = num::ToPrimitive::to_usize(self).unwrap();
        let prev_value = (num_value.overflowing_sub(1).0) % EditableArea::VARIANT_COUNT;

        num::FromPrimitive::from_usize(prev_value).unwrap()
    }
}

#[derive(Debug, PartialEq)]
enum ReplacementResult {
    InvalidRegex,
    NoMatch,
    Unchanged,
    Replaced(String),
}

fn compose_regex(regex_str: &str, flags: MatchFlags) -> Option<Regex> {
    let flags_str = if flags.contains(MatchFlags::ICASE) {
        "i"
    } else {
        ""
    };
    let composed_str = format!("(?{}:{})", flags_str, regex_str);

    Regex::new(&composed_str).ok()
}

fn try_replace(
    text: &str,
    regex: &Option<Regex>,
    replacement: &str,
    global: bool,
) -> ReplacementResult {
    if let Some(regex) = regex.as_ref() {
        if !regex.is_match(text) {
            ReplacementResult::NoMatch
        } else {
            let replaced = if global {
                regex.replace_all(text, replacement)
            } else {
                regex.replace(text, replacement)
            };

            if replaced == text {
                ReplacementResult::Unchanged
            } else {
                ReplacementResult::Replaced(replaced.into())
            }
        }
    } else {
        ReplacementResult::InvalidRegex
    }
}

pub enum AppResult {
    MoveFiles(Vec<(PathBuf, PathBuf)>),
    Exit,
}

pub struct App {
    /// current value of the regex input box
    regex: String,
    /// current value of the replacement string box
    replacement: String,
    /// match flags
    flags: MatchFlags,
    /// active editing area where the cursor is
    active_area: EditableArea,
    /// source files to rename
    source_files: Vec<PathBuf>,
}

impl Default for App {
    fn default() -> App {
        App {
            regex: String::new(),
            replacement: String::new(),
            flags: MatchFlags::NO_FLAGS,
            active_area: EditableArea::Regex,
            source_files: Vec::new(),
        }
    }
}

impl App {
    pub fn with_files(mut self, files: Vec<PathBuf>) -> Self {
        self.source_files = files
            .into_iter()
            .map(|path| path_utils::normalize_path(&path))
            .collect();
        self
    }

    pub fn with_regex(mut self, regex: String) -> Self {
        self.regex = regex;
        self
    }

    pub fn with_replacement(mut self, replacement: String) -> Self {
        self.replacement = replacement;
        self
    }

    fn is_global(&self) -> bool {
        self.flags.contains(MatchFlags::GLOBAL)
    }

    pub fn run<B: Backend>(&mut self, terminal: &mut Terminal<B>) -> std::io::Result<AppResult> {
        let mut keys_iter = termion::async_stdin().keys();

        loop {
            terminal.draw(|f| self.ui(f))?;

            let edited_string = match self.active_area {
                EditableArea::Regex => &mut self.regex,
                EditableArea::Replace => &mut self.replacement,
            };

            if let Some(Ok(key)) = keys_iter.next() {
                match key {
                    Key::Ctrl('c') => {
                        return Ok(AppResult::Exit);
                    }
                    Key::Char('\t') => {
                        self.active_area = self.active_area.next();
                    }
                    Key::BackTab => {
                        self.active_area = self.active_area.prev();
                    }
                    Key::Backspace => {
                        edited_string.pop();
                    }
                    Key::Ctrl('g') => {
                        self.flags ^= MatchFlags::GLOBAL;
                    }
                    Key::Ctrl('r') => {
                        self.flags ^= MatchFlags::ICASE;
                    }
                    Key::Char('\n') => {
                        let re = Regex::new(&self.regex).ok();

                        let move_pairs: Vec<(PathBuf, PathBuf)> = self
                            .source_files
                            .clone()
                            .into_iter()
                            .filter_map(path_utils::split_path)
                            .filter_map(|(parent, name)| {
                                match try_replace(&name, &re, &self.replacement, self.is_global()) {
                                    ReplacementResult::Replaced(dst_name) => {
                                        let src_path = parent.join(name);
                                        let dst_path = parent.join(dst_name);

                                        Some((src_path, dst_path))
                                    }
                                    _ => None,
                                }
                            })
                            .collect();

                        return Ok(AppResult::MoveFiles(move_pairs));
                    }
                    Key::Char(ch) => {
                        edited_string.push(ch);
                    }
                    _ => {}
                }
            }
            thread::sleep(Duration::from_millis(20));
        }
    }

    fn ui<B: Backend>(&self, frame: &mut Frame<B>) {
        let re = compose_regex(&self.regex, self.flags);

        // editor and help areas
        let main_layout = Layout::default()
            .direction(Direction::Horizontal)
            .constraints([Constraint::Min(50), Constraint::Max(25)])
            .split(frame.size());

        // editor area: regex, replacement, flags, files list
        let editor_layout = Layout::default()
            .direction(Direction::Vertical)
            .constraints([Constraint::Length(3), Constraint::Percentage(100)])
            .split(main_layout[0].inner(&Margin {
                vertical: 0,
                horizontal: 0,
            }));

        // regex and replacement inputs, flags
        let top_row_layout = Layout::default()
            .direction(Direction::Horizontal)
            .constraints([Constraint::Min(0), Constraint::Length(7)])
            .split(editor_layout[0].inner(&Margin {
                vertical: 0,
                horizontal: 0,
            }));

        // regex and replacement inputs
        let input_layout = Layout::default()
            .direction(Direction::Horizontal)
            .constraints([Constraint::Ratio(1, 2), Constraint::Ratio(1, 2)])
            .split(top_row_layout[0].inner(&Margin {
                vertical: 0,
                horizontal: 0,
            }));

        let regex_input = Paragraph::new(self.regex.as_ref())
            .style(if re.as_ref().is_some() {
                Style::default()
            } else {
                Style::default().fg(Color::Red)
            })
            .block(Block::default().title("Regex").borders(Borders::ALL));
        frame.render_widget(regex_input, input_layout[0]);

        let replace_input = Paragraph::new(self.replacement.as_ref())
            .block(Block::default().title("Replacement").borders(Borders::ALL));
        frame.render_widget(replace_input, input_layout[1]);

        let flags_view = Paragraph::new(self.flags.to_string())
            .block(Block::default().title("Flags").borders(Borders::ALL));
        frame.render_widget(flags_view, top_row_layout[1]);

        match self.active_area {
            EditableArea::Regex => {
                frame.set_cursor(
                    // Put cursor past the end of the regex
                    input_layout[0].x + self.regex.len() as u16 + 1,
                    // Move one line down, from the border to the regex input
                    input_layout[0].y + 1,
                );
            }
            EditableArea::Replace => {
                frame.set_cursor(
                    // Put cursor past the end of the replacement
                    input_layout[1].x + self.replacement.len() as u16 + 1,
                    // Move one line down, from the border to the replacement input
                    input_layout[1].y + 1,
                );
            }
        }

        let files_list: Vec<Spans> = self
            .source_files
            .clone()
            .into_iter()
            .filter_map(path_utils::split_path)
            .map(|(parent, name)| {
                let dir_style = Style::default().add_modifier(Modifier::BOLD);
                let src_name_style = Style::default().fg(Color::Red);
                let dst_name_style = Style::default().fg(Color::Green);

                let dir_str = parent.to_str().unwrap().to_owned() + "/";

                match try_replace(&name, &re, &self.replacement, self.is_global()) {
                    ReplacementResult::Replaced(dst_name) => Spans::from(vec![
                        Span::styled(dir_str, dir_style),
                        Span::styled(name, src_name_style),
                        Span::raw("->"),
                        Span::styled(dst_name, dst_name_style),
                    ]),
                    _ => Spans::from(vec![Span::styled(dir_str, dir_style), Span::from(name)]),
                }
            })
            .collect();

        let files_view = Paragraph::new(files_list)
            .wrap(Wrap { trim: false })
            .block(Block::default().title("Files").borders(Borders::ALL));
        frame.render_widget(files_view, editor_layout[1]);

        let help_list: Vec<Spans> = vec![
            ("Tab", "switch between regex and replacement areas"),
            ("Enter", "execute renaming"),
            ("Ctrl-g", "'global' flag"),
            ("Ctrl-r", "'icase' flag"),
            ("Ctrl-c", "exit"),
        ]
        .into_iter()
        .map(|(key, descr)| {
            Spans::from(vec![
                Span::styled(key, Style::default().add_modifier(Modifier::BOLD)),
                Span::raw(" - "),
                Span::raw(descr),
            ])
        })
        .collect();
        let help_view = Paragraph::new(help_list)
            .wrap(Wrap { trim: false })
            .block(Block::default().title("Help").borders(Borders::ALL));
        frame.render_widget(help_view, main_layout[1]);
    }
}

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

    mod editable_area {
        use super::*;

        #[rstest]
        #[case(EditableArea::Regex, EditableArea::Replace)]
        #[case(EditableArea::Replace, EditableArea::Regex)]
        fn next(#[case] current_area: EditableArea, #[case] expected_next_area: EditableArea) {
            let next_area = current_area.next();
            assert_eq!(next_area, expected_next_area);
        }

        #[rstest]
        #[case(EditableArea::Regex, EditableArea::Replace)]
        #[case(EditableArea::Replace, EditableArea::Regex)]
        fn prev(#[case] current_area: EditableArea, #[case] expected_next_area: EditableArea) {
            let next_area = current_area.prev();
            assert_eq!(next_area, expected_next_area);
        }
    }

    #[rstest]
    #[case("a", None, "b", false, ReplacementResult::InvalidRegex)]
    #[case("abc", Regex::new("bc").ok(), "bc", false, ReplacementResult::Unchanged)]
    #[case("abc", Regex::new("(ab)(.*)").ok(), "$2$1", false, ReplacementResult::Replaced("cab".into()))]
    // case vs ignore case
    #[case("aBc", Regex::new("abc").ok(), "", false, ReplacementResult::NoMatch)]
    #[case("aBc", Regex::new("(?i:abc)").ok(), "", false, ReplacementResult::Replaced("".into()))]
    // non-global vs global 
    #[case("abac", Regex::new("a").ok(), "d", false, ReplacementResult::Replaced("dbac".into()))]
    #[case("abac", Regex::new("a").ok(), "d", true, ReplacementResult::Replaced("dbdc".into()))]
    fn try_replace_works(
        #[case] text: &str,
        #[case] regex: Option<Regex>,
        #[case] replacement: &str,
        #[case] global: bool,
        #[case] expected_result: ReplacementResult,
    ) {
        let replacement_result = try_replace(text, &regex, replacement, global);
        assert_eq!(replacement_result, expected_result);
    }
}