Add flag for case-insensitive sort-by (#2225)

* Add flag for case-insensitive sort-by

* Fix test names

* Fix documentation comments

crates/nu-cli/src/commands/math/median.rs

@@ -73,7 +73,7 @@ pub fn median(values: &[Value], name: &Tag) -> Result<Value, ShellError> {
         sorted.push(item.clone());
     }
 
-    crate::commands::sort_by::sort(&mut sorted, &[], name)?;
+    crate::commands::sort_by::sort(&mut sorted, &[], name, false)?;
 
     match take {
         Pick::Median => {

crates/nu-cli/src/commands/math/mode.rs

@@ -77,7 +77,7 @@ pub fn mode(values: &[Value], name: &Tag) -> Result<Value, ShellError> {
         }
     }
 
-    crate::commands::sort_by::sort(&mut modes, &[], name)?;
+    crate::commands::sort_by::sort(&mut modes, &[], name, false)?;
     Ok(UntaggedValue::Table(modes).into_value(name))
 }
 

crates/nu-cli/src/commands/sort_by.rs

@@ -11,6 +11,7 @@ pub struct SortBy;
 #[derive(Deserialize)]
 pub struct SortByArgs {
     rest: Vec<Tagged<String>>,
+    insensitive: bool,
 }
 
 #[async_trait]
@@ -20,7 +21,13 @@ impl WholeStreamCommand for SortBy {
     }
 
     fn signature(&self) -> Signature {
-        Signature::build("sort-by").rest(SyntaxShape::String, "the column(s) to sort by")
+        Signature::build("sort-by")
+            .switch(
+                "insensitive",
+                "Sort string-based columns case insensitively",
+                Some('i'),
+            )
+            .rest(SyntaxShape::String, "the column(s) to sort by")
     }
 
     fn usage(&self) -> &str {
@@ -57,6 +64,24 @@ impl WholeStreamCommand for SortBy {
                 example: "ls | sort-by type size",
                 result: None,
             },
+            Example {
+                description: "Sort strings (case sensitive)",
+                example: "echo [airplane Truck Car] | sort-by",
+                result: Some(vec![
+                    UntaggedValue::string("Car").into(),
+                    UntaggedValue::string("Truck").into(),
+                    UntaggedValue::string("airplane").into(),
+                ]),
+            },
+            Example {
+                description: "Sort strings (case insensitive)",
+                example: "echo [airplane Truck Car] | sort-by -i",
+                result: Some(vec![
+                    UntaggedValue::string("airplane").into(),
+                    UntaggedValue::string("Car").into(),
+                    UntaggedValue::string("Truck").into(),
+                ]),
+            },
         ]
     }
 }
@@ -68,10 +93,10 @@ async fn sort_by(
     let registry = registry.clone();
     let tag = args.call_info.name_tag.clone();
 
-    let (SortByArgs { rest }, mut input) = args.process(&registry).await?;
+    let (SortByArgs { rest, insensitive }, mut input) = args.process(&registry).await?;
     let mut vec = input.drain_vec().await;
 
-    sort(&mut vec, &rest, &tag)?;
+    sort(&mut vec, &rest, &tag, insensitive)?;
 
     Ok(futures::stream::iter(vec.into_iter()).to_output_stream())
 }
@@ -80,6 +105,7 @@ pub fn sort(
     vec: &mut [Value],
     keys: &[Tagged<String>],
     tag: impl Into<Tag>,
+    insensitive: bool,
 ) -> Result<(), ShellError> {
     let tag = tag.into();
 
@@ -107,12 +133,38 @@ pub fn sort(
             value: UntaggedValue::Primitive(_),
             ..
         } => {
-            vec.sort_by(|a, b| coerce_compare(a, b).expect("Unimplemented BUG: What about primitives that don't have an order defined?").compare());
+            let should_sort_case_insensitively = insensitive && vec.iter().all(|x| x.is_string());
+
+            vec.sort_by(|a, b| {
+                if should_sort_case_insensitively {
+                    let lowercase_a_string = a.expect_string().to_ascii_lowercase();
+                    let lowercase_b_string = b.expect_string().to_ascii_lowercase();
+
+                    lowercase_a_string.cmp(&lowercase_b_string)
+                } else {
+                    coerce_compare(a, b).expect("Unimplemented BUG: What about primitives that don't have an order defined?").compare()
+                }
+            });
         }
         _ => {
             let calc_key = |item: &Value| {
                 keys.iter()
-                    .map(|f| get_data_by_key(item, f.borrow_spanned()))
+                    .map(|f| {
+                        let mut value_option = get_data_by_key(item, f.borrow_spanned());
+
+                        if insensitive {
+                            if let Some(value) = &value_option {
+                                if let Ok(string_value) = value.as_string() {
+                                    value_option = Some(
+                                        UntaggedValue::string(string_value.to_ascii_lowercase())
+                                            .into_value(value.tag.clone()),
+                                    )
+                                }
+                            }
+                        }
+
+                        value_option
+                    })
                     .collect::<Vec<Option<Value>>>()
             };
             vec.sort_by_cached_key(calc_key);

crates/nu-cli/tests/commands/sort_by.rs

@@ -62,3 +62,71 @@ fn sort_primitive_values() {
 
     assert_eq!(actual.out, "authors = [\"The Nu Project Contributors\"]");
 }
+
+#[test]
+fn ls_sort_by_name_sensitive() {
+    let actual = nu!(
+        cwd: "tests/fixtures/formats", pipeline(
+        r#"
+            open sample-ls-output.json
+            | sort-by name
+            | select name
+            | to json
+        "#
+    ));
+
+    let json_output = r#"[{"name":"B.txt"},{"name":"C"},{"name":"a.txt"}]"#;
+
+    assert_eq!(actual.out, json_output);
+}
+
+#[test]
+fn ls_sort_by_name_insensitive() {
+    let actual = nu!(
+        cwd: "tests/fixtures/formats", pipeline(
+        r#"
+            open sample-ls-output.json
+            | sort-by -i name
+            | select name
+            | to json
+        "#
+    ));
+
+    let json_output = r#"[{"name":"a.txt"},{"name":"B.txt"},{"name":"C"}]"#;
+
+    assert_eq!(actual.out, json_output);
+}
+
+#[test]
+fn ls_sort_by_type_name_sensitive() {
+    let actual = nu!(
+        cwd: "tests/fixtures/formats", pipeline(
+        r#"
+            open sample-ls-output.json
+            | sort-by type name
+            | select name type
+            | to json
+        "#
+    ));
+
+    let json_output = r#"[{"name":"C","type":"Dir"},{"name":"B.txt","type":"File"},{"name":"a.txt","type":"File"}]"#;
+
+    assert_eq!(actual.out, json_output);
+}
+
+#[test]
+fn ls_sort_by_type_name_insensitive() {
+    let actual = nu!(
+        cwd: "tests/fixtures/formats", pipeline(
+        r#"
+            open sample-ls-output.json
+            | sort-by -i type name
+            | select name type
+            | to json
+        "#
+    ));
+
+    let json_output = r#"[{"name":"C","type":"Dir"},{"name":"a.txt","type":"File"},{"name":"B.txt","type":"File"}]"#;
+
+    assert_eq!(actual.out, json_output);
+}