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
use std::collections::{BTreeMap, BTreeSet};
use std::fmt::Write as FWrite;
use std::default::Default;
use semver::VersionReq;
use std::borrow::Cow;
use std::path::Path;
use std::fs;
use toml;
/// A single operation to be executed upon configuration of a package.
#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum ConfigOperation {
/// Set the toolchain to use to compile the package.
SetToolchain(String),
/// Use the default toolchain to use to compile the package.
RemoveToolchain,
/// Whether to compile the package with the default features.
DefaultFeatures(bool),
/// Compile the package with the specified feature.
AddFeature(String),
/// Remove the feature from the list of features to compile with.
RemoveFeature(String),
/// Set debug mode being enabled to the specified value.
SetDebugMode(bool),
/// Set allowing to install prereleases to the specified value.
SetInstallPrereleases(bool),
/// Set enforcing Cargo.lock to the specified value.
SetEnforceLock(bool),
/// Set installing only the pre-set binaries.
SetRespectBinaries(bool),
/// Constrain the installed to the specified one.
SetTargetVersion(VersionReq),
/// Always install latest package version.
RemoveTargetVersion,
/// Reset configuration to default values.
ResetConfig,
}
/// Compilation configuration for one crate.
///
/// # Examples
///
/// Reading a configset, adding an entry to it, then writing it back.
///
/// ```
/// # use cargo_update::ops::PackageConfig;
/// # use std::fs::{File, create_dir_all};
/// # use std::env::temp_dir;
/// # let td = temp_dir().join("cargo_update-doctest").join("PackageConfig-0");
/// # create_dir_all(&td).unwrap();
/// # let config_file = td.join(".install_config.toml");
/// # let operations = [];
/// let mut configuration = PackageConfig::read(&config_file).unwrap();
/// configuration.insert("cargo_update".to_string(), PackageConfig::from(&operations));
/// PackageConfig::write(&configuration, &config_file).unwrap();
/// ```
#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
pub struct PackageConfig {
/// Toolchain to use to compile the package, or `None` for default.
pub toolchain: Option<String>,
/// Whether to compile the package with the default features.
pub default_features: bool,
/// Features to compile the package with.
pub features: BTreeSet<String>,
/// Whether to compile in debug mode.
pub debug: Option<bool>,
/// Whether to install pre-release versions.
pub install_prereleases: Option<bool>,
/// Whether to enforce Cargo.lock versions.
pub enforce_lock: Option<bool>,
/// Whether to install only the pre-configured binaries.
pub respect_binaries: Option<bool>,
/// Versions to constrain to.
pub target_version: Option<VersionReq>,
}
impl PackageConfig {
/// Create a package config based on the default settings and modified according to the specified operations.
///
/// # Examples
///
/// ```
/// # extern crate cargo_update;
/// # extern crate semver;
/// # fn main() {
/// # use cargo_update::ops::{ConfigOperation, PackageConfig};
/// # use std::collections::BTreeSet;
/// # use semver::VersionReq;
/// # use std::str::FromStr;
/// assert_eq!(PackageConfig::from(&[ConfigOperation::SetToolchain("nightly".to_string()),
/// ConfigOperation::DefaultFeatures(false),
/// ConfigOperation::AddFeature("rustc-serialize".to_string()),
/// ConfigOperation::SetDebugMode(true),
/// ConfigOperation::SetInstallPrereleases(false),
/// ConfigOperation::SetEnforceLock(true),
/// ConfigOperation::SetRespectBinaries(true),
/// ConfigOperation::SetTargetVersion(VersionReq::from_str(">=0.1").unwrap())]),
/// PackageConfig {
/// toolchain: Some("nightly".to_string()),
/// default_features: false,
/// features: {
/// let mut feats = BTreeSet::new();
/// feats.insert("rustc-serialize".to_string());
/// feats
/// },
/// debug: Some(true),
/// install_prereleases: Some(false),
/// enforce_lock: Some(true),
/// respect_binaries: Some(true),
/// target_version: Some(VersionReq::from_str(">=0.1").unwrap()),
/// });
/// # }
/// ```
pub fn from<'o, O: IntoIterator<Item = &'o ConfigOperation>>(ops: O) -> PackageConfig {
let mut def = PackageConfig::default();
def.execute_operations(ops);
def
}
/// Generate cargo arguments from this configuration.
///
/// Executable names are stripped of their trailing `".exe"`, if any.
///
/// # Examples
///
/// ```no_run
/// # use cargo_update::ops::PackageConfig;
/// # use std::collections::BTreeMap;
/// # use std::process::Command;
/// # let name = "cargo-update".to_string();
/// # let mut configuration = BTreeMap::new();
/// # configuration.insert(name.clone(), PackageConfig::from(&[]));
/// let cmd = Command::new("cargo")
/// .args(configuration.get(&name).unwrap().cargo_args(&["racer"]).iter().map(AsRef::as_ref))
/// .arg(&name)
/// // Process the command further -- run it, for example.
/// # .status().unwrap();
/// # let _ = cmd;
/// ```
pub fn cargo_args<S: AsRef<str>, I: IntoIterator<Item = S>>(&self, executables: I) -> Vec<Cow<'static, str>> {
let mut res = vec![];
if let Some(ref t) = self.toolchain {
res.push(format!("+{}", t).into());
}
res.push("install".into());
res.push("-f".into());
if !self.default_features {
res.push("--no-default-features".into());
}
if !self.features.is_empty() {
res.push("--features".into());
let mut a = String::new();
for f in &self.features {
write!(a, "{} ", f).unwrap();
}
res.push(a.into());
}
if let Some(true) = self.enforce_lock {
res.push("--locked".into());
}
if let Some(true) = self.respect_binaries {
for x in executables {
let x = x.as_ref();
res.push("--bin".into());
res.push(if x.ends_with(".exe") {
&x[..x.len() - 4]
} else {
x
}
.to_string()
.into());
}
}
if let Some(true) = self.debug {
res.push("--debug".into());
}
res
}
/// Modify `self` according to the specified set of operations.
///
/// # Examples
///
/// ```
/// # extern crate cargo_update;
/// # extern crate semver;
/// # fn main() {
/// # use cargo_update::ops::{ConfigOperation, PackageConfig};
/// # use std::collections::BTreeSet;
/// # use semver::VersionReq;
/// # use std::str::FromStr;
/// let mut cfg = PackageConfig {
/// toolchain: Some("nightly".to_string()),
/// default_features: false,
/// features: {
/// let mut feats = BTreeSet::new();
/// feats.insert("rustc-serialize".to_string());
/// feats
/// },
/// debug: None,
/// install_prereleases: None,
/// enforce_lock: None,
/// respect_binaries: None,
/// target_version: Some(VersionReq::from_str(">=0.1").unwrap()),
/// };
/// cfg.execute_operations(&[ConfigOperation::RemoveToolchain,
/// ConfigOperation::AddFeature("serde".to_string()),
/// ConfigOperation::RemoveFeature("rustc-serialize".to_string()),
/// ConfigOperation::SetDebugMode(true),
/// ConfigOperation::RemoveTargetVersion]);
/// assert_eq!(cfg,
/// PackageConfig {
/// toolchain: None,
/// default_features: false,
/// features: {
/// let mut feats = BTreeSet::new();
/// feats.insert("serde".to_string());
/// feats
/// },
/// debug: Some(true),
/// install_prereleases: None,
/// enforce_lock: None,
/// respect_binaries: None,
/// target_version: None,
/// });
/// # }
/// ```
pub fn execute_operations<'o, O: IntoIterator<Item = &'o ConfigOperation>>(&mut self, ops: O) {
for op in ops {
self.execute_operation(op)
}
}
fn execute_operation(&mut self, op: &ConfigOperation) {
match *op {
ConfigOperation::SetToolchain(ref tchn) => self.toolchain = Some(tchn.clone()),
ConfigOperation::RemoveToolchain => self.toolchain = None,
ConfigOperation::DefaultFeatures(f) => self.default_features = f,
ConfigOperation::AddFeature(ref feat) => {
self.features.insert(feat.clone());
}
ConfigOperation::RemoveFeature(ref feat) => {
self.features.remove(feat);
}
ConfigOperation::SetDebugMode(d) => self.debug = Some(d),
ConfigOperation::SetInstallPrereleases(pr) => self.install_prereleases = Some(pr),
ConfigOperation::SetEnforceLock(el) => self.enforce_lock = Some(el),
ConfigOperation::SetRespectBinaries(rb) => self.respect_binaries = Some(rb),
ConfigOperation::SetTargetVersion(ref vr) => self.target_version = Some(vr.clone()),
ConfigOperation::RemoveTargetVersion => self.target_version = None,
ConfigOperation::ResetConfig => *self = Default::default(),
}
}
/// Read a configset from the specified file.
///
/// If the specified file doesn't exist an empty configset is returned.
///
/// # Examples
///
/// ```
/// # use std::collections::{BTreeSet, BTreeMap};
/// # use cargo_update::ops::PackageConfig;
/// # use std::fs::{self, create_dir_all};
/// # use std::env::temp_dir;
/// # use std::io::Write;
/// # let td = temp_dir().join("cargo_update-doctest").join("PackageConfig-read-0");
/// # create_dir_all(&td).unwrap();
/// # let config_file = td.join(".install_config.toml");
/// fs::write(&config_file, &b"\
/// [cargo-update]\n\
/// default_features = true\n\
/// features = [\"serde\"]\n"[..]).unwrap();
/// assert_eq!(PackageConfig::read(&config_file), Ok({
/// let mut pkgs = BTreeMap::new();
/// pkgs.insert("cargo-update".to_string(), PackageConfig {
/// toolchain: None,
/// default_features: true,
/// features: {
/// let mut feats = BTreeSet::new();
/// feats.insert("serde".to_string());
/// feats
/// },
/// debug: None,
/// install_prereleases: None,
/// enforce_lock: None,
/// respect_binaries: None,
/// target_version: None,
/// });
/// pkgs
/// }));
/// ```
pub fn read(p: &Path) -> Result<BTreeMap<String, PackageConfig>, (String, i32)> {
if p.exists() {
toml::from_str(&fs::read_to_string(p).map_err(|e| (e.to_string(), 1))?).map_err(|e| (e.to_string(), 2))
} else {
Ok(BTreeMap::new())
}
}
/// Save a configset to the specified file.
///
/// # Examples
///
/// ```
/// # use std::collections::{BTreeSet, BTreeMap};
/// # use cargo_update::ops::PackageConfig;
/// # use std::fs::{self, create_dir_all};
/// # use std::env::temp_dir;
/// # use std::io::Read;
/// # let td = temp_dir().join("cargo_update-doctest").join("PackageConfig-write-0");
/// # create_dir_all(&td).unwrap();
/// # let config_file = td.join(".install_config.toml");
/// PackageConfig::write(&{
/// let mut pkgs = BTreeMap::new();
/// pkgs.insert("cargo-update".to_string(), PackageConfig {
/// toolchain: None,
/// default_features: true,
/// features: {
/// let mut feats = BTreeSet::new();
/// feats.insert("serde".to_string());
/// feats
/// },
/// debug: None,
/// install_prereleases: None,
/// enforce_lock: None,
/// respect_binaries: None,
/// target_version: None,
/// });
/// pkgs
/// }, &config_file).unwrap();
///
/// assert_eq!(&fs::read_to_string(&config_file).unwrap(),
/// "[cargo-update]\n\
/// default_features = true\n\
/// features = [\"serde\"]\n");
/// ```
pub fn write(configuration: &BTreeMap<String, PackageConfig>, p: &Path) -> Result<(), (String, i32)> {
fs::write(p, &toml::to_vec(configuration).map_err(|e| (e.to_string(), 2))?).map_err(|e| (e.to_string(), 3))
}
}
impl Default for PackageConfig {
fn default() -> PackageConfig {
PackageConfig {
toolchain: None,
default_features: true,
features: BTreeSet::new(),
debug: None,
install_prereleases: None,
enforce_lock: None,
respect_binaries: None,
target_version: None,
}
}
}