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
// Copyright (c) The cargo-guppy Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
//! Add and remove dependencies.
use crate::{
cli_ops::{WorkspaceOp, WorkspaceOps},
hakari::DepFormatVersion,
HakariBuilder,
};
use guppy::{
graph::{DependencyDirection, PackageLink, PackageMetadata, PackageSet},
VersionReq,
};
impl<'g> HakariBuilder<'g> {
/// Returns the set of operations that need to be performed to add the workspace-hack
/// dependency to the given set of workspace crates.
///
/// Also includes remove operations for the workspace-hack dependency from excluded crates.
///
/// Returns `None` if the hakari package wasn't specified at construction time.
///
/// Requires the `cli-support` feature to be enabled.
pub fn manage_dep_ops(&self, workspace_set: &PackageSet<'g>) -> Option<WorkspaceOps<'g, '_>> {
let graph = self.graph();
let hakari_package = self.hakari_package()?;
let (add_to, remove_from) =
workspace_set.filter_partition(DependencyDirection::Reverse, |package| {
let link_opt = package
.link_to(hakari_package.id())
.expect("valid package ID");
let should_be_included = !self.is_excluded(package.id()).expect("valid package ID");
match (link_opt, should_be_included) {
(None, true) => Some(true),
(Some(_), false) => Some(false),
(Some(link), true) => match self.dep_format_version {
DepFormatVersion::V1 => None,
DepFormatVersion::V2 | DepFormatVersion::V3 | DepFormatVersion::V4 => {
needs_update_v2(hakari_package, link).then_some(true)
}
},
(None, false) => None,
}
});
let mut ops = Vec::with_capacity(2);
if !add_to.is_empty() {
ops.push(WorkspaceOp::AddDependency {
name: hakari_package.name(),
crate_path: hakari_package
.source()
.workspace_path()
.expect("hakari package is in workspace"),
version: hakari_package.version(),
dep_format: self.dep_format_version,
line_style: self.workspace_hack_line_style,
add_to,
});
}
if !remove_from.is_empty() {
ops.push(WorkspaceOp::RemoveDependency {
name: hakari_package.name(),
remove_from,
});
}
Some(WorkspaceOps::new(graph, ops))
}
/// Returns the set of operations that need to be performed to add the workspace-hack
/// dependency to the given set of workspace crates.
///
/// Returns `None` if the hakari package wasn't specified at construction time.
///
/// Requires the `cli-support` feature to be enabled.
pub fn add_dep_ops(
&self,
workspace_set: &PackageSet<'g>,
force: bool,
) -> Option<WorkspaceOps<'g, '_>> {
let graph = self.graph();
let hakari_package = self.hakari_package()?;
let add_to = if force {
workspace_set.clone()
} else {
workspace_set.filter(DependencyDirection::Reverse, |package| {
let link_opt = package
.link_to(hakari_package.id())
.expect("valid package ID");
match link_opt {
Some(link) => needs_update_v2(hakari_package, link),
None => true,
}
})
};
let op = if !add_to.is_empty() {
Some(WorkspaceOp::AddDependency {
name: hakari_package.name(),
version: hakari_package.version(),
crate_path: hakari_package
.source()
.workspace_path()
.expect("hakari package is in workspace"),
dep_format: self.dep_format_version,
line_style: self.workspace_hack_line_style,
add_to,
})
} else {
None
};
Some(WorkspaceOps::new(graph, op))
}
/// Returns the set of operations that need to be performed to remove the workspace-hack
/// dependency from the given set of workspace crates.
///
/// Returns `None` if the hakari package wasn't specified at construction time.
///
/// Requires the `cli-support` feature to be enabled.
pub fn remove_dep_ops(
&self,
workspace_set: &PackageSet<'g>,
force: bool,
) -> Option<WorkspaceOps<'g, '_>> {
let graph = self.graph();
let hakari_package = self.hakari_package()?;
let remove_from = if force {
workspace_set.clone()
} else {
workspace_set.filter(DependencyDirection::Reverse, |package| {
graph
.directly_depends_on(package.id(), hakari_package.id())
.expect("valid package ID")
})
};
let op = if !remove_from.is_empty() {
Some(WorkspaceOp::RemoveDependency {
name: hakari_package.name(),
remove_from,
})
} else {
None
};
Some(WorkspaceOps::new(graph, op))
}
}
#[allow(clippy::if_same_then_else, clippy::needless_bool)]
fn needs_update_v2(hakari_package: &PackageMetadata<'_>, link: PackageLink<'_>) -> bool {
if !link.version_req().matches(hakari_package.version()) {
// The version number doesn't match: it must be updated.
true
} else if link.version_req() == &VersionReq::STAR {
// The version number isn't specified and force_version is true.
true
} else {
false
}
}