yerba 0.7.3

YAML Editing and Refactoring with Better Accuracy
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
use super::*;

impl Document {
  pub fn move_item(&mut self, dot_path: &str, from: usize, to: usize) -> Result<(), YerbaError> {
    if from == to {
      return Ok(());
    }

    let current_node = self.navigate(dot_path)?;

    let sequence = find_block_sequence(&current_node).ok_or_else(|| YerbaError::NotASequence(dot_path.to_string()))?;

    let entries: Vec<_> = sequence.entries().collect();

    self.reorder_entries(sequence.syntax(), &entries, from, to)
  }

  pub fn move_key(&mut self, dot_path: &str, from: usize, to: usize) -> Result<(), YerbaError> {
    if from == to {
      return Ok(());
    }

    let current_node = self.navigate(dot_path)?;

    let map = find_block_map(&current_node).ok_or_else(|| YerbaError::SelectorNotFound(dot_path.to_string()))?;

    let entries: Vec<_> = map.entries().collect();

    self.reorder_entries(map.syntax(), &entries, from, to)
  }

  pub fn resolve_key_index(&self, dot_path: &str, reference: &str) -> Result<usize, YerbaError> {
    let current_node = self.navigate(dot_path)?;

    let map = find_block_map(&current_node).ok_or_else(|| YerbaError::SelectorNotFound(dot_path.to_string()))?;

    if let Ok(index) = reference.parse::<usize>() {
      let length = map.entries().count();

      if index >= length {
        return Err(YerbaError::IndexOutOfBounds(index, length));
      }

      return Ok(index);
    }

    map
      .entries()
      .enumerate()
      .find(|(_index, entry)| {
        entry
          .key()
          .and_then(|key_node| extract_scalar_text(key_node.syntax()))
          .map(|key_text| key_text == reference)
          .unwrap_or(false)
      })
      .map(|(index, _entry)| index)
      .ok_or_else(|| YerbaError::SelectorNotFound(format!("{} key '{}'", dot_path, reference)))
  }

  pub fn resolve_sequence_index(&self, dot_path: &str, reference: &str) -> Result<usize, YerbaError> {
    let current_node = self.navigate(dot_path)?;

    let sequence = find_block_sequence(&current_node).ok_or_else(|| YerbaError::NotASequence(dot_path.to_string()))?;

    if let Ok(index) = reference.parse::<usize>() {
      let length = sequence.entries().count();

      if index >= length {
        return Err(YerbaError::IndexOutOfBounds(index, length));
      }

      return Ok(index);
    }

    if crate::selector::Selector::parse(reference).is_relative() {
      return sequence
        .entries()
        .enumerate()
        .find(|(_index, entry)| self.evaluate_condition_on_node(entry.syntax(), reference))
        .map(|(index, _entry)| index)
        .ok_or_else(|| YerbaError::SelectorNotFound(format!("{} condition '{}'", dot_path, reference)));
    }

    sequence
      .entries()
      .enumerate()
      .find(|(_index, entry)| {
        entry
          .flow()
          .and_then(|flow| extract_scalar_text(flow.syntax()))
          .map(|text| text == reference)
          .unwrap_or(false)
      })
      .map(|(index, _entry)| index)
      .ok_or_else(|| YerbaError::SelectorNotFound(format!("{} item '{}'", dot_path, reference)))
  }

  pub fn validate_sort_keys(&self, dot_path: &str, key_order: &[&str]) -> Result<(), YerbaError> {
    if let Some(sequence_path) = strip_bracket_suffix(dot_path) {
      return self.validate_each_sort_keys(sequence_path, key_order);
    }

    let current_node = match self.navigate(dot_path) {
      Ok(node) => node,
      Err(_) => return Ok(()),
    };

    let map = match find_block_map(&current_node) {
      Some(map) => map,
      None => return Ok(()),
    };

    let unknown_keys: Vec<String> = map
      .entries()
      .filter_map(|entry| entry.key().and_then(|key_node| extract_scalar_text(key_node.syntax())))
      .filter(|key_name| !key_order.contains(&key_name.as_str()))
      .collect();

    if unknown_keys.is_empty() {
      Ok(())
    } else {
      Err(YerbaError::UnknownKeys(unknown_keys))
    }
  }

  pub fn sort_keys(&mut self, dot_path: &str, key_order: &[&str]) -> Result<(), YerbaError> {
    if let Some(sequence_path) = strip_bracket_suffix(dot_path) {
      return self.sort_each_keys(sequence_path, key_order);
    }

    let current_node = match self.navigate(dot_path) {
      Ok(node) => node,
      Err(_) => return Ok(()),
    };

    let map = match find_block_map(&current_node) {
      Some(map) => map,
      None => return Ok(()),
    };

    match sort_map_edit(&map, key_order) {
      Some(edit) => self.apply_edits(vec![edit]),
      None => Ok(()),
    }
  }

  pub fn sort_each_keys(&mut self, dot_path: &str, key_order: &[&str]) -> Result<(), YerbaError> {
    let nodes = if dot_path.is_empty() {
      match self.navigate(dot_path) {
        Ok(node) => vec![node],
        Err(_) => return Ok(()),
      }
    } else {
      let found = self.navigate_all_compact(dot_path);
      if found.is_empty() {
        return Ok(());
      }
      found
    };

    let mut edits: Vec<(TextRange, String)> = Vec::new();

    for current_node in &nodes {
      let sequence = match find_block_sequence(current_node) {
        Some(sequence) => sequence,
        None => continue,
      };

      for entry in sequence.entries() {
        let map = match find_block_map(entry.syntax()) {
          Some(map) => map,
          None => continue,
        };

        if let Some(edit) = sort_map_edit(&map, key_order) {
          edits.push(edit);
        }
      }
    }

    self.apply_edits(edits)
  }

  pub fn validate_each_sort_keys(&self, dot_path: &str, key_order: &[&str]) -> Result<(), YerbaError> {
    let nodes = if dot_path.is_empty() {
      match self.navigate(dot_path) {
        Ok(node) => vec![node],
        Err(_) => return Ok(()),
      }
    } else {
      let found = self.navigate_all_compact(dot_path);
      if found.is_empty() {
        return Ok(());
      }
      found
    };

    let mut all_unknown: Vec<String> = Vec::new();

    for current_node in &nodes {
      let sequence = match find_block_sequence(current_node) {
        Some(sequence) => sequence,
        None => continue,
      };

      for entry in sequence.entries() {
        if let Some(map) = find_block_map(entry.syntax()) {
          for map_entry in map.entries() {
            if let Some(key_name) = map_entry.key().and_then(|key_node| extract_scalar_text(key_node.syntax())) {
              if !key_order.contains(&key_name.as_str()) && !all_unknown.contains(&key_name) {
                all_unknown.push(key_name);
              }
            }
          }
        }
      }
    }

    if all_unknown.is_empty() {
      Ok(())
    } else {
      Err(YerbaError::UnknownKeys(all_unknown))
    }
  }

  pub fn sort_items(&mut self, dot_path: &str, sort_fields: &[SortField], case_sensitive: bool) -> Result<(), YerbaError> {
    if dot_path.contains("[].") {
      return self.sort_each_items(dot_path, sort_fields, case_sensitive);
    }

    let current_node = self.navigate(dot_path)?;

    let sequence = match find_block_sequence(&current_node) {
      Some(sequence) => sequence,
      None => return Ok(()),
    };

    match sort_sequence_edit(&sequence, sort_fields, case_sensitive) {
      Some(edit) => self.apply_edits(vec![edit]),
      None => Ok(()),
    }
  }

  fn sort_each_items(&mut self, dot_path: &str, sort_fields: &[SortField], case_sensitive: bool) -> Result<(), YerbaError> {
    let (parent_path, child_path) = if let Some(last_bracket) = dot_path.rfind("[].") {
      (&dot_path[..last_bracket + 2], &dot_path[last_bracket + 3..])
    } else {
      (dot_path, "")
    };

    let parent_nodes = self.navigate_all_compact(parent_path);
    let mut edits: Vec<(TextRange, String)> = Vec::new();

    for parent_node in &parent_nodes {
      let child_nodes = if child_path.is_empty() {
        vec![parent_node.clone()]
      } else {
        navigate_from_node(parent_node, child_path)
      };

      for child_node in &child_nodes {
        let sequence = match find_block_sequence(child_node) {
          Some(sequence) => sequence,
          None => continue,
        };

        if let Some(edit) = sort_sequence_edit(&sequence, sort_fields, case_sensitive) {
          edits.push(edit);
        }
      }
    }

    self.apply_edits(edits)
  }

  pub fn reorder_items(&mut self, dot_path: &str, by: &str, desired_order: &[&str]) -> Result<(), YerbaError> {
    let field = by.strip_prefix('.').unwrap_or(by);
    let is_scalar = field.is_empty() || field == ".";

    let items_selector = if is_scalar {
      if dot_path.is_empty() {
        "[]".to_string()
      } else {
        format!("{}[]", dot_path)
      }
    } else if dot_path.is_empty() {
      format!("[].{}", field)
    } else {
      format!("{}[].{}", dot_path, field)
    };

    let labels: Vec<String> = match self.get_value(&items_selector) {
      Some(yaml_serde::Value::Sequence(sequence)) => sequence
        .iter()
        .map(|value| match value {
          yaml_serde::Value::String(string) => string.clone(),
          _ => String::new(),
        })
        .collect(),
      _ => return Err(YerbaError::SelectorNotFound(items_selector)),
    };

    let mut used = vec![false; labels.len()];
    let mut moves: Vec<usize> = Vec::new();

    for desired in desired_order {
      let found = labels.iter().enumerate().find(|(index, label)| label.as_str() == *desired && !used[*index]);

      if let Some((index, _)) = found {
        moves.push(index);
        used[index] = true;
      } else {
        return Err(YerbaError::SelectorNotFound(format!("no item found with {} == \"{}\"", by, desired)));
      }
    }

    let missing: Vec<&String> = labels.iter().enumerate().filter(|(index, _)| !used[*index]).map(|(_, label)| label).collect();

    if !missing.is_empty() {
      let missing_list = missing.iter().map(|s| s.as_str()).collect::<Vec<_>>().join(", ");

      return Err(YerbaError::SelectorNotFound(format!(
        "order must specify all {} items, but {} missing: {}",
        labels.len(),
        missing.len(),
        missing_list
      )));
    }

    for target in 0..moves.len() {
      let source = moves[target];

      if source != target {
        self.move_item(dot_path, source, target)?;

        for item in moves.iter_mut().skip(target + 1) {
          if *item >= target && *item < source {
            *item += 1;
          } else if *item == source {
            *item = target;
          }
        }
      }
    }

    Ok(())
  }
}

fn sort_map_edit(map: &BlockMap, key_order: &[&str]) -> Option<(TextRange, String)> {
  let entries: Vec<_> = map.entries().collect();

  if entries.len() <= 1 {
    return None;
  }

  let (groups, range) = collect_groups_with_range(map.syntax());

  let mut keyed: Vec<(String, EntryGroup)> = entries
    .iter()
    .zip(groups)
    .map(|(entry, group)| {
      let key_name = entry.key().and_then(|key_node| extract_scalar_text(key_node.syntax())).unwrap_or_default();
      (key_name, group)
    })
    .collect();

  let original_keys: Vec<String> = keyed.iter().map(|(key, _)| key.clone()).collect();

  keyed.sort_by(|(key_a, _), (key_b, _)| {
    let position_a = key_order.iter().position(|&key| key == key_a);
    let position_b = key_order.iter().position(|&key| key == key_b);

    match (position_a, position_b) {
      (Some(a), Some(b)) => a.cmp(&b),
      (Some(_), None) => std::cmp::Ordering::Less,
      (None, Some(_)) => std::cmp::Ordering::Greater,
      (None, None) => {
        let original_a = original_keys.iter().position(|key| key == key_a).unwrap();
        let original_b = original_keys.iter().position(|key| key == key_b).unwrap();

        original_a.cmp(&original_b)
      }
    }
  });

  let sorted_keys: Vec<&str> = keyed.iter().map(|(key, _)| key.as_str()).collect();
  let original_refs: Vec<&str> = original_keys.iter().map(|key| key.as_str()).collect();

  if sorted_keys == original_refs {
    return None;
  }

  let indent = entries.get(1).map(|entry| preceding_whitespace_indent(entry.syntax())).unwrap_or_default();
  let sorted_groups: Vec<EntryGroup> = keyed.into_iter().map(|(_, group)| group).collect();

  Some((range, rebuild_from_groups(&sorted_groups, &indent, false)))
}

fn sort_sequence_edit(sequence: &BlockSeq, sort_fields: &[SortField], case_sensitive: bool) -> Option<(TextRange, String)> {
  let entries: Vec<_> = sequence.entries().collect();

  if entries.len() <= 1 {
    return None;
  }

  let (groups, range) = collect_groups_with_range(sequence.syntax());

  let mut sortable: Vec<(Vec<String>, EntryGroup)> = entries
    .iter()
    .zip(groups)
    .map(|(entry, group)| (entry_sort_values(entry, sort_fields), group))
    .collect();

  let original_bodies: Vec<String> = sortable.iter().map(|(_, group)| group.body.clone()).collect();

  sortable.sort_by(|(values_a, _), (values_b, _)| compare_sort_values(values_a, values_b, sort_fields, case_sensitive));

  let sorted_bodies: Vec<String> = sortable.iter().map(|(_, group)| group.body.clone()).collect();

  if sorted_bodies == original_bodies {
    return None;
  }

  let indent = entries.get(1).map(|entry| preceding_whitespace_indent(entry.syntax())).unwrap_or_default();
  let sorted_groups: Vec<EntryGroup> = sortable.into_iter().map(|(_, group)| group).collect();

  Some((range, rebuild_from_groups(&sorted_groups, &indent, true)))
}

fn entry_sort_values(entry: &yaml_parser::ast::BlockSeqEntry, sort_fields: &[SortField]) -> Vec<String> {
  let scalar_value = || entry.flow().and_then(|flow| extract_scalar_text(flow.syntax())).unwrap_or_default();

  if sort_fields.is_empty() {
    return vec![scalar_value()];
  }

  sort_fields
    .iter()
    .map(|field| {
      if field.path.is_empty() {
        scalar_value()
      } else {
        let nodes = navigate_from_node(entry.syntax(), &field.path);
        nodes.first().and_then(extract_scalar_text).unwrap_or_default()
      }
    })
    .collect()
}

fn compare_sort_values(values_a: &[String], values_b: &[String], sort_fields: &[SortField], case_sensitive: bool) -> std::cmp::Ordering {
  let compare = |value_a: &String, value_b: &String| {
    if case_sensitive {
      value_a.cmp(value_b)
    } else {
      value_a.to_lowercase().cmp(&value_b.to_lowercase())
    }
  };

  for (index, field) in sort_fields.iter().enumerate().take(values_a.len()) {
    let ordering = compare(&values_a[index], &values_b[index]);
    let ordering = if field.ascending { ordering } else { ordering.reverse() };

    if ordering != std::cmp::Ordering::Equal {
      return ordering;
    }
  }

  if sort_fields.is_empty() && !values_a.is_empty() && !values_b.is_empty() {
    return compare(&values_a[0], &values_b[0]);
  }

  std::cmp::Ordering::Equal
}

fn strip_bracket_suffix(path: &str) -> Option<&str> {
  if path == "[]" {
    Some("")
  } else if let Some(stripped) = path.strip_suffix(".[]") {
    Some(stripped)
  } else {
    path.strip_suffix("[]")
  }
}