summaryrefslogtreecommitdiff
path: root/support/texlab/src/rename/bibtex_entry.rs
blob: 97eaa8fd9dc47e9ba97427f83624b81b006d6ff5 (plain)
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
use crate::{
    feature::{FeatureProvider, FeatureRequest},
    protocol::{
        Position, Range, RangeExt, RenameParams, TextDocumentPositionParams, TextEdit,
        WorkspaceEdit,
    },
    syntax::{Span, SyntaxNode},
    workspace::DocumentContent,
};
use async_trait::async_trait;
use std::collections::HashMap;

#[derive(Debug, PartialEq, Eq, Clone, Copy, Default)]
pub struct BibtexEntryPrepareRenameProvider;

#[async_trait]
impl FeatureProvider for BibtexEntryPrepareRenameProvider {
    type Params = TextDocumentPositionParams;
    type Output = Option<Range>;

    async fn execute<'a>(&'a self, req: &'a FeatureRequest<Self::Params>) -> Self::Output {
        find_key(&req.current().content, req.params.position).map(Span::range)
    }
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, Default)]
pub struct BibtexEntryRenameProvider;

#[async_trait]
impl FeatureProvider for BibtexEntryRenameProvider {
    type Params = RenameParams;
    type Output = Option<WorkspaceEdit>;

    async fn execute<'a>(&'a self, req: &'a FeatureRequest<Self::Params>) -> Self::Output {
        let key_name = find_key(
            &req.current().content,
            req.params.text_document_position.position,
        )?;
        let mut changes = HashMap::new();
        for doc in req.related() {
            let edits = match &doc.content {
                DocumentContent::Latex(table) => table
                    .citations
                    .iter()
                    .flat_map(|citation| citation.keys(&table))
                    .filter(|citation| citation.text() == key_name.text)
                    .map(|citation| TextEdit::new(citation.range(), req.params.new_name.clone()))
                    .collect(),
                DocumentContent::Bibtex(tree) => tree
                    .children(tree.root)
                    .filter_map(|node| tree.as_entry(node))
                    .filter_map(|entry| entry.key.as_ref())
                    .filter(|entry_key| entry_key.text() == key_name.text)
                    .map(|entry_key| TextEdit::new(entry_key.range(), req.params.new_name.clone()))
                    .collect(),
            };
            changes.insert(doc.uri.clone().into(), edits);
        }
        Some(WorkspaceEdit::new(changes))
    }
}

fn find_key(content: &DocumentContent, pos: Position) -> Option<&Span> {
    match content {
        DocumentContent::Latex(table) => table
            .citations
            .iter()
            .flat_map(|citation| citation.keys(&table))
            .find(|key| key.range().contains(pos))
            .map(|key| &key.span),
        DocumentContent::Bibtex(tree) => tree
            .children(tree.root)
            .filter_map(|node| tree.as_entry(node))
            .filter_map(|entry| entry.key.as_ref())
            .find(|key| key.range().contains(pos))
            .map(|key| &key.span),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{feature::FeatureTester, protocol::RangeExt};
    use indoc::indoc;

    #[tokio::test]
    async fn entry() {
        let actual_edit = FeatureTester::new()
            .file("main.bib", r#"@article{foo, bar = baz}"#)
            .file(
                "main.tex",
                indoc!(
                    r#"
                        \addbibresource{main.bib}
                        \cite{foo}
                    "#
                ),
            )
            .main("main.bib")
            .position(0, 9)
            .new_name("qux")
            .test_rename(BibtexEntryRenameProvider)
            .await
            .unwrap();

        let mut expected_changes = HashMap::new();
        expected_changes.insert(
            FeatureTester::uri("main.bib").into(),
            vec![TextEdit::new(Range::new_simple(0, 9, 0, 12), "qux".into())],
        );
        expected_changes.insert(
            FeatureTester::uri("main.tex").into(),
            vec![TextEdit::new(Range::new_simple(1, 6, 1, 9), "qux".into())],
        );
        let expected_edit = WorkspaceEdit::new(expected_changes);

        assert_eq!(actual_edit, expected_edit);
    }

    #[tokio::test]
    async fn citation() {
        let actual_edit = FeatureTester::new()
            .file("main.bib", r#"@article{foo, bar = baz}"#)
            .file(
                "main.tex",
                indoc!(
                    r#"
                    \addbibresource{main.bib}
                    \cite{foo}
                "#
                ),
            )
            .main("main.tex")
            .position(1, 6)
            .new_name("qux")
            .test_rename(BibtexEntryRenameProvider)
            .await
            .unwrap();

        let mut expected_changes = HashMap::new();
        expected_changes.insert(
            FeatureTester::uri("main.bib").into(),
            vec![TextEdit::new(Range::new_simple(0, 9, 0, 12), "qux".into())],
        );
        expected_changes.insert(
            FeatureTester::uri("main.tex").into(),
            vec![TextEdit::new(Range::new_simple(1, 6, 1, 9), "qux".into())],
        );
        let expected_edit = WorkspaceEdit::new(expected_changes);

        assert_eq!(actual_edit, expected_edit);
    }

    #[tokio::test]
    async fn field_name() {
        let actual_edit = FeatureTester::new()
            .file("main.bib", r#"@article{foo, bar = baz}"#)
            .main("main.bib")
            .position(0, 14)
            .new_name("qux")
            .test_rename(BibtexEntryRenameProvider)
            .await;

        assert_eq!(actual_edit, None);
    }

    #[tokio::test]
    async fn empty_latex_document() {
        let actual_edit = FeatureTester::new()
            .file("main.tex", "")
            .main("main.tex")
            .position(0, 0)
            .new_name("")
            .test_rename(BibtexEntryRenameProvider)
            .await;

        assert_eq!(actual_edit, None);
    }

    #[tokio::test]
    async fn empty_bibtex_document() {
        let actual_edit = FeatureTester::new()
            .file("main.bib", "")
            .main("main.bib")
            .position(0, 0)
            .new_name("")
            .test_rename(BibtexEntryRenameProvider)
            .await;

        assert_eq!(actual_edit, None);
    }
}