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
486
487
488
489
490
491
492
493
494
495
use std::fs::{self, File, OpenOptions};
use std::io::{Read, Write};
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::{env, str};
use termcolor::{BufferWriter, Color, ColorChoice, ColorSpec, WriteColor};
use toml_edit;
use dependency::Dependency;
use errors::*;
const MANIFEST_FILENAME: &str = "Cargo.toml";
#[derive(Debug, Clone)]
pub struct Manifest {
pub data: toml_edit::Document,
}
pub fn find(specified: &Option<PathBuf>) -> Result<PathBuf> {
match *specified {
Some(ref path)
if fs::metadata(&path)
.chain_err(|| "Failed to get cargo file metadata")?
.is_file() =>
{
Ok(path.to_owned())
}
Some(ref path) => search(path),
None => search(&env::current_dir().chain_err(|| "Failed to get current directory")?),
}
}
fn search(dir: &Path) -> Result<PathBuf> {
let manifest = dir.join(MANIFEST_FILENAME);
if fs::metadata(&manifest).is_ok() {
Ok(manifest)
} else {
dir.parent()
.ok_or_else(|| ErrorKind::MissingManifest.into())
.and_then(|dir| search(dir))
}
}
fn merge_inline_table(old_dep: &mut toml_edit::Item, new: &toml_edit::Item) {
for (k, v) in new.as_inline_table()
.expect("expected an inline table")
.iter()
{
old_dep[k] = toml_edit::value(v.clone());
}
}
fn str_or_1_len_table(item: &toml_edit::Item) -> bool {
item.is_str() || item.as_table_like().map(|t| t.len() == 1).unwrap_or(false)
}
fn merge_dependencies(old_dep: &mut toml_edit::Item, new: &Dependency) {
assert!(!old_dep.is_none());
let new_toml = new.to_toml().1;
if str_or_1_len_table(old_dep) {
*old_dep = new_toml;
} else if old_dep.is_table_like() {
for key in &["version", "path", "git"] {
old_dep[key] = toml_edit::Item::None;
}
if let Some(name) = new_toml.as_str() {
old_dep["version"] = toml_edit::value(name);
} else {
merge_inline_table(old_dep, &new_toml);
}
} else {
unreachable!("Invalid old dependency type");
}
if let Some(t) = old_dep.as_inline_table_mut() {
t.fmt()
}
}
fn print_upgrade_if_necessary(
crate_name: &str,
old_dep: &toml_edit::Item,
new_version: &toml_edit::Item,
) -> Result<()> {
let old_version = if str_or_1_len_table(old_dep) {
old_dep.clone()
} else if old_dep.is_table_like() {
let version = old_dep["version"].clone();
if version.is_none() {
return Err("Missing version field".into());
}
version
} else {
unreachable!("Invalid old dependency type")
};
if let (Some(old_version), Some(new_version)) = (old_version.as_str(), new_version.as_str()) {
if old_version == new_version {
return Ok(());
}
let bufwtr = BufferWriter::stdout(ColorChoice::Always);
let mut buffer = bufwtr.buffer();
buffer
.set_color(ColorSpec::new().set_fg(Some(Color::Green)).set_bold(true))
.chain_err(|| "Failed to set output colour")?;
write!(&mut buffer, " Upgrading ").chain_err(|| "Failed to write upgrade message")?;
buffer
.set_color(&ColorSpec::new())
.chain_err(|| "Failed to clear output colour")?;
writeln!(
&mut buffer,
"{} v{} -> v{}",
crate_name, old_version, new_version,
).chain_err(|| "Failed to write upgrade versions")?;
bufwtr
.print(&buffer)
.chain_err(|| "Failed to print upgrade message")?;
}
Ok(())
}
impl Manifest {
pub fn find_file(path: &Option<PathBuf>) -> Result<File> {
find(path).and_then(|path| {
OpenOptions::new()
.read(true)
.write(true)
.open(path)
.chain_err(|| "Failed to find Cargo.toml")
})
}
pub fn open(path: &Option<PathBuf>) -> Result<Manifest> {
let mut file = Manifest::find_file(path)?;
let mut data = String::new();
file.read_to_string(&mut data)
.chain_err(|| "Failed to read manifest contents")?;
data.parse().chain_err(|| "Unable to parse Cargo.toml")
}
pub fn get_table<'a>(&'a mut self, table_path: &[String]) -> Result<&'a mut toml_edit::Item> {
fn descend<'a>(
input: &'a mut toml_edit::Item,
path: &[String],
) -> Result<&'a mut toml_edit::Item> {
if let Some(segment) = path.get(0) {
let value = input[&segment].or_insert(toml_edit::table());
if value.is_table_like() {
descend(value, &path[1..])
} else {
Err(ErrorKind::NonExistentTable(segment.clone()).into())
}
} else {
Ok(input)
}
}
descend(&mut self.data.root, table_path)
}
pub fn get_sections(&self) -> Vec<(Vec<String>, toml_edit::Item)> {
let mut sections = Vec::new();
for dependency_type in &["dev-dependencies", "build-dependencies", "dependencies"] {
if self.data[dependency_type].is_table_like() {
sections.push((
vec![dependency_type.to_string()],
self.data[dependency_type].clone(),
))
}
let target_sections = self.data
.as_table()
.get("target")
.and_then(toml_edit::Item::as_table_like)
.into_iter()
.flat_map(|t| t.iter())
.filter_map(|(target_name, target_table)| {
let dependency_table = &target_table[dependency_type];
dependency_table.as_table_like().map(|_| {
(
vec![
"target".to_string(),
target_name.to_string(),
dependency_type.to_string(),
],
dependency_table.clone(),
)
})
});
sections.extend(target_sections);
}
sections
}
pub fn write_to_file(&self, file: &mut File) -> Result<()> {
if self.data["package"].is_none() && self.data["project"].is_none() {
if !self.data["workspace"].is_none() {
Err(ErrorKind::UnexpectedRootManifest)?;
} else {
Err(ErrorKind::InvalidManifest)?;
}
}
let s = self.data.to_string();
let new_contents_bytes = s.as_bytes();
file.set_len(new_contents_bytes.len() as u64)
.chain_err(|| "Failed to truncate Cargo.toml")?;
file.write_all(new_contents_bytes)
.chain_err(|| "Failed to write updated Cargo.toml")
}
pub fn insert_into_table(&mut self, table_path: &[String], dep: &Dependency) -> Result<()> {
let table = self.get_table(table_path)?;
if table[&dep.name].is_none() {
let (ref name, ref mut new_dependency) = dep.to_toml();
table[name] = new_dependency.clone();
} else {
merge_dependencies(&mut table[&dep.name], dep);
if let Some(t) = table.as_inline_table_mut() {
t.fmt()
}
}
Ok(())
}
pub fn update_table_entry(
&mut self,
table_path: &[String],
dep: &Dependency,
dry_run: bool,
) -> Result<()> {
let table = self.get_table(table_path)?;
let new_dep = dep.to_toml().1;
if !table[&dep.name].is_none() {
if let Err(e) = print_upgrade_if_necessary(&dep.name, &table[&dep.name], &new_dep) {
eprintln!("Error while displaying upgrade message, {}", e);
}
if !dry_run {
merge_dependencies(&mut table[&dep.name], dep);
if let Some(t) = table.as_inline_table_mut() {
t.fmt()
}
}
}
Ok(())
}
pub fn remove_from_table(&mut self, table: &str, name: &str) -> Result<()> {
if !self.data[table].is_table_like() {
Err(ErrorKind::NonExistentTable(table.into()))?;
} else {
{
let dep = &mut self.data[table][name];
if dep.is_none() {
Err(ErrorKind::NonExistentDependency(name.into(), table.into()))?;
}
*dep = toml_edit::Item::None;
}
if self.data[table].as_table_like().unwrap().is_empty() {
self.data[table] = toml_edit::Item::None;
}
}
Ok(())
}
pub fn add_deps(&mut self, table: &[String], deps: &[Dependency]) -> Result<()> {
deps.iter()
.map(|dep| self.insert_into_table(table, dep))
.collect::<Result<Vec<_>>>()?;
Ok(())
}
}
impl str::FromStr for Manifest {
type Err = Error;
fn from_str(input: &str) -> ::std::result::Result<Self, Self::Err> {
let d: toml_edit::Document = input.parse().chain_err(|| "Manifest not valid TOML")?;
Ok(Manifest { data: d })
}
}
#[derive(Debug)]
pub struct LocalManifest {
path: PathBuf,
manifest: Manifest,
}
impl Deref for LocalManifest {
type Target = Manifest;
fn deref(&self) -> &Manifest {
&self.manifest
}
}
impl LocalManifest {
pub fn find(path: &Option<PathBuf>) -> Result<Self> {
let path = find(path)?;
Self::try_new(&path)
}
pub fn try_new(path: &Path) -> Result<Self> {
let path = path.to_path_buf();
Ok(LocalManifest {
manifest: Manifest::open(&Some(path.clone()))?,
path,
})
}
fn get_file(&self) -> Result<File> {
Manifest::find_file(&Some(self.path.clone()))
}
pub fn upgrade(&mut self, dependency: &Dependency, dry_run: bool) -> Result<()> {
for (table_path, table) in self.get_sections() {
let table_like = table.as_table_like().expect("Unexpected non-table");
for (name, _old_value) in table_like.iter() {
if name == dependency.name {
self.manifest
.update_table_entry(&table_path, dependency, dry_run)?;
}
}
}
let mut file = self.get_file()?;
self.write_to_file(&mut file)
.chain_err(|| "Failed to write new manifest contents")
}
}
#[cfg(test)]
mod tests {
use super::*;
use dependency::Dependency;
use toml_edit;
#[test]
fn add_remove_dependency() {
let mut manifest = Manifest {
data: toml_edit::Document::new(),
};
let clone = manifest.clone();
let dep = Dependency::new("cargo-edit").set_version("0.1.0");
let _ = manifest.insert_into_table(&["dependencies".to_owned()], &dep);
assert!(
manifest
.remove_from_table("dependencies", &dep.name)
.is_ok()
);
assert_eq!(manifest.data.to_string(), clone.data.to_string());
}
#[test]
fn update_dependency() {
let mut manifest = Manifest {
data: toml_edit::Document::new(),
};
let dep = Dependency::new("cargo-edit").set_version("0.1.0");
manifest
.insert_into_table(&["dependencies".to_owned()], &dep)
.unwrap();
let new_dep = Dependency::new("cargo-edit").set_version("0.2.0");
manifest
.update_table_entry(&["dependencies".to_owned()], &new_dep, false)
.unwrap();
}
#[test]
fn update_wrong_dependency() {
let mut manifest = Manifest {
data: toml_edit::Document::new(),
};
let dep = Dependency::new("cargo-edit").set_version("0.1.0");
manifest
.insert_into_table(&["dependencies".to_owned()], &dep)
.unwrap();
let original = manifest.clone();
let new_dep = Dependency::new("wrong-dep").set_version("0.2.0");
manifest
.update_table_entry(&["dependencies".to_owned()], &new_dep, false)
.unwrap();
assert_eq!(manifest.data.to_string(), original.data.to_string());
}
#[test]
fn remove_dependency_no_section() {
let mut manifest = Manifest {
data: toml_edit::Document::new(),
};
let dep = Dependency::new("cargo-edit").set_version("0.1.0");
assert!(
manifest
.remove_from_table("dependencies", &dep.name)
.is_err()
);
}
#[test]
fn remove_dependency_non_existent() {
let mut manifest = Manifest {
data: toml_edit::Document::new(),
};
let dep = Dependency::new("cargo-edit").set_version("0.1.0");
let other_dep = Dependency::new("other-dep").set_version("0.1.0");
let _ = manifest.insert_into_table(&["dependencies".to_owned()], &other_dep);
assert!(
manifest
.remove_from_table("dependencies", &dep.name)
.is_err()
);
}
}