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
#![warn(clippy::all)]
use git2::Oid;
use std::collections::HashMap;
use std::path::{Path, PathBuf};

/// Track file changes for a file - renames and deletes
#[derive(Debug, Clone)]
pub struct GitFileFutureRegistry {
    rev_changes: HashMap<Oid, RevChange>,
}

#[derive(Debug, Clone)]
struct RevChange {
    files: HashMap<PathBuf, FileNameChange>,
    /// first child is generally used only, it is the main branch - don't divert into other branches!
    children: Vec<Oid>,
}

#[derive(Debug, Clone)]
pub enum FileNameChange {
    Renamed(PathBuf),
    Deleted(),
}

impl RevChange {
    pub fn new() -> Self {
        RevChange {
            files: HashMap::new(),
            children: Vec::new(),
        }
    }
}

impl GitFileFutureRegistry {
    pub fn new() -> Self {
        GitFileFutureRegistry {
            rev_changes: HashMap::new(),
        }
    }

    pub fn register(
        &mut self,
        id: &Oid,
        parent_ids: &[Oid],
        file_changes: &[(PathBuf, FileNameChange)],
    ) {
        let entry = self.rev_changes.entry(*id).or_insert_with(RevChange::new);
        (*entry).files.extend(file_changes.iter().cloned());
        for parent_id in parent_ids {
            let pentry = self
                .rev_changes
                .entry(*parent_id)
                .or_insert_with(RevChange::new);
            (*pentry).children.push(*id);
        }
    }

    /// what is this called in the final revision?
    /// returns None if it is deleted, or Some(final name)
    pub fn final_name(&self, ref_id: &Oid, file: &Path) -> Option<PathBuf> {
        let mut current_name: &PathBuf = &file.to_path_buf();
        let mut current_ref: Oid = *ref_id;
        loop {
            let current_change = self.rev_changes.get(&current_ref).unwrap();
            match current_change.files.get(current_name) {
                Some(FileNameChange::Renamed(new_name)) => {
                    current_name = new_name;
                }
                Some(FileNameChange::Deleted()) => return None,
                None => (),
            }
            if let Some(first_child) = current_change.children.get(0) {
                current_ref = *first_child;
            // and loop will continue
            } else {
                // no children, so finished looking into the future
                return Some(current_name.to_path_buf());
            }
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use failure::Error;
    use pretty_assertions::assert_eq;

    fn pb(name: &str) -> PathBuf {
        PathBuf::from(name)
    }

    #[test]
    fn trivial_repo_returns_original_name() -> Result<(), Error> {
        let mut registry = GitFileFutureRegistry::new();
        let my_id = Oid::from_str("01")?;
        registry.register(&my_id, &[], &[]);
        assert_eq!(
            registry.final_name(&my_id, &pb("foo.txt")),
            Some(pb("foo.txt"))
        );
        Ok(())
    }

    #[test]
    fn simple_rename_returns_old_name() -> Result<(), Error> {
        let mut registry = GitFileFutureRegistry::new();
        let my_id = Oid::from_str("01")?;

        registry.register(
            &my_id,
            &[],
            &[(pb("foo.txt"), FileNameChange::Renamed(pb("bar.txt")))],
        );
        assert_eq!(
            registry.final_name(&my_id, &pb("foo.txt")),
            Some(pb("bar.txt"))
        );
        Ok(())
    }

    #[test]
    fn renames_and_deletes_applied_across_history() -> Result<(), Error> {
        // my bad - this should be a few isolated tests not one big test-all test.
        // classic how my standards slip for side projects!
        let mut registry = GitFileFutureRegistry::new();
        /*
                   +-----+
                   |01   |
                   |add a|
                   |add z|
                   +--+--+
                      |
               +------v------+
               |02           |
               |rename a to b|
               |delete z     |
               +-------------+
               |             |
        +------v------+ +----v--------+
        |04           | |05           |
        |rename b to c| |rename b to d|
        +--------------+--------------+
                       |
              +--------v---------+
              |06 merge          |
              |rename c to afinal|
              |create new z      |
              +------------------+
                */
        let id_1 = Oid::from_str("01")?;
        let id_2 = Oid::from_str("02")?;
        let id_4 = Oid::from_str("04")?;
        let id_5 = Oid::from_str("05")?;
        let id_6 = Oid::from_str("06")?;

        registry.register(
            &id_6,
            &[id_4, id_5],
            &[(pb("c"), FileNameChange::Renamed(pb("afinal")))],
        );
        // NOTE: topological order should (I think?) register rev 4 before rev 5 as it's first
        registry.register(
            &id_4,
            &[id_2],
            &[(pb("b"), FileNameChange::Renamed(pb("c")))],
        );
        registry.register(
            &id_5,
            &[id_2],
            &[(pb("b"), FileNameChange::Renamed(pb("d")))],
        );
        registry.register(
            &id_2,
            &[id_1],
            &[
                (pb("a"), FileNameChange::Renamed(pb("b"))),
                (pb("z"), FileNameChange::Deleted()),
            ],
        );
        registry.register(&id_1, &[], &[]);

        // original a is afinal
        // original z is gone
        assert_eq!(registry.final_name(&id_1, &pb("a")), Some(pb("afinal")));
        assert_eq!(registry.final_name(&id_1, &pb("z")), None);
        // from the perspective of the filesystem after node 2, we know nothing of a any more, only b
        assert_eq!(registry.final_name(&id_2, &pb("b")), Some(pb("afinal")));

        Ok(())
    }
}