Auto merge of #5013 - withoutboats:no-rust-rename, r=matklad

bors · bors · commit a99768918b56 · 2018-02-06T06:08:23.000Z
Do not rename packages on `cargo new`.

Prior to this commit, packages beginning with `rust` or ending with
`rs` were renamed automatically when created, unless they were
binaries. The ostensible purpose of this code was to avoid people
uploading "redundant" names to crates.io, which is a repository of
Rust packages.

This behavior was overly opinionated. It is not cargo's
responsibility to discourage users from naming their packages any
particular way. Without a sound technical reasons why packages
cannot be named a certain way, cargo should not be intervening in
users' package naming decisions.

It also did this by automatically renaming the package for the
user, as opposed to erroring. Though it printed a message about
the behavior, it did not give the user a choice to abort the
process; to overrule cargo they had to delete the new project
and start again using the `--name` argument.

`cargo new` is many users' first entrypoint to the Rust ecosystem.
This behavior teaches a user that Rust is opinionated and magical,
both of which are divisive attributes for a tool, and attributes
which do not generally describe Rust's attitude toward things like
names and formatting.

If crates.io wishes to enforce that users not upload packages with
names like this, it should be enforced by crates.io at publish
time.
diff --git a/src/cargo/ops/cargo_new.rs b/src/cargo/ops/cargo_new.rs
@@ -91,32 +91,18 @@ struct CargoNewConfig {
     version_control: Option<VersionControl>,
 }
 
-fn get_name<'a>(path: &'a Path, opts: &'a NewOptions, config: &Config) -> CargoResult<&'a str> {
+fn get_name<'a>(path: &'a Path, opts: &'a NewOptions) -> CargoResult<&'a str> {
     if let Some(name) = opts.name {
         return Ok(name);
     }
 
-    if path.file_name().is_none() {
-        bail!("cannot auto-detect project name from path {:?} ; use --name to override",
-                              path.as_os_str());
-    }
-
-    let dir_name = path.file_name().and_then(|s| s.to_str()).ok_or_else(|| {
-        format_err!("cannot create a project with a non-unicode name: {:?}",
-                    path.file_name().unwrap())
+    let file_name = path.file_name().ok_or_else(|| {
+        format_err!("cannot auto-detect project name from path {:?} ; use --name to override", path.as_os_str())
     })?;
 
-    if opts.bin {
-        Ok(dir_name)
-    } else {
-        let new_name = strip_rust_affixes(dir_name);
-        if new_name != dir_name {
-            writeln!(config.shell().err(),
-                     "note: package will be named `{}`; use --name to override",
-                     new_name)?;
-        }
-        Ok(new_name)
-    }
+    file_name.to_str().ok_or_else(|| {
+        format_err!("cannot create project with a non-unicode name: {:?}", file_name)
+    })
 }
 
 fn check_name(name: &str, opts: &NewOptions) -> CargoResult<()> {
@@ -287,7 +273,7 @@ pub fn new(opts: &NewOptions, config: &Config) -> CargoResult<()> {
         bail!("can't specify both lib and binary outputs")
     }
 
-    let name = get_name(&path, opts, config)?;
+    let name = get_name(&path, opts)?;
     check_name(name, opts)?;
 
     let mkopts = MkOptions {
@@ -317,7 +303,7 @@ pub fn init(opts: &NewOptions, config: &Config) -> CargoResult<()> {
         bail!("can't specify both lib and binary outputs");
     }
 
-    let name = get_name(&path, opts, config)?;
+    let name = get_name(&path, opts)?;
     check_name(name, opts)?;
 
     let mut src_paths_types = vec![];
@@ -381,20 +367,6 @@ pub fn init(opts: &NewOptions, config: &Config) -> CargoResult<()> {
     Ok(())
 }
 
-fn strip_rust_affixes(name: &str) -> &str {
-    for &prefix in &["rust-", "rust_", "rs-", "rs_"] {
-        if name.starts_with(prefix) {
-            return &name[prefix.len()..];
-        }
-    }
-    for &suffix in &["-rust", "_rust", "-rs", "_rs"] {
-        if name.ends_with(suffix) {
-            return &name[..name.len()-suffix.len()];
-        }
-    }
-    name
-}
-
 fn existing_vcs_repo(path: &Path, cwd: &Path) -> bool {
     GitRepo::discover(path, cwd).is_ok() || HgRepo::discover(path, cwd).is_ok()
 }
@@ -605,20 +577,3 @@ fn global_config(config: &Config) -> CargoResult<CargoNewConfig> {
         version_control: vcs,
     })
 }
-
-#[cfg(test)]
-mod tests {
-    use super::strip_rust_affixes;
-
-    #[test]
-    fn affixes_stripped() {
-        assert_eq!(strip_rust_affixes("rust-foo"), "foo");
-        assert_eq!(strip_rust_affixes("foo-rs"), "foo");
-        assert_eq!(strip_rust_affixes("rs_foo"), "foo");
-        // Only one affix is stripped
-        assert_eq!(strip_rust_affixes("rs-foo-rs"), "foo-rs");
-        assert_eq!(strip_rust_affixes("foo-rs-rs"), "foo-rs");
-        // It shouldn't touch the middle
-        assert_eq!(strip_rust_affixes("some-rust-crate"), "some-rust-crate");
-    }
-}
diff --git a/tests/new.rs b/tests/new.rs
@@ -163,37 +163,6 @@ fn keyword_name() {
 use --name to override crate name"));
 }
 
-#[test]
-fn rust_prefix_stripped() {
-    assert_that(cargo_process("new").arg("--lib").arg("rust-foo").env("USER", "foo"),
-                execs().with_status(0)
-                       .with_stderr_contains("note: package will be named `foo`; use --name to override"));
-    let toml = paths::root().join("rust-foo/Cargo.toml");
-    let mut contents = String::new();
-    File::open(&toml).unwrap().read_to_string(&mut contents).unwrap();
-    assert!(contents.contains(r#"name = "foo""#));
-}
-
-#[test]
-fn bin_disables_stripping() {
-    assert_that(cargo_process("new").arg("rust-foo").arg("--bin").env("USER", "foo"),
-                execs().with_status(0));
-    let toml = paths::root().join("rust-foo/Cargo.toml");
-    let mut contents = String::new();
-    File::open(&toml).unwrap().read_to_string(&mut contents).unwrap();
-    assert!(contents.contains(r#"name = "rust-foo""#));
-}
-
-#[test]
-fn explicit_name_not_stripped() {
-    assert_that(cargo_process("new").arg("foo").arg("--name").arg("rust-bar").env("USER", "foo"),
-                execs().with_status(0));
-    let toml = paths::root().join("foo/Cargo.toml");
-    let mut contents = String::new();
-    File::open(&toml).unwrap().read_to_string(&mut contents).unwrap();
-    assert!(contents.contains(r#"name = "rust-bar""#));
-}
-
 #[test]
 fn finds_author_user() {
     create_empty_gitconfig();
@@ -423,4 +392,4 @@ fn explicit_invalid_name_not_suggested() {
                 execs().with_status(101)
                        .with_stderr("\
 [ERROR] Package names starting with a digit cannot be used as a crate name"));
-}
+}
