✨ Add to xml command (#2141) (#2155)

Cargo.lock

@@ -455,7 +455,7 @@ dependencies = [
  "codepage",
  "encoding_rs",
  "log",
- "quick-xml",
+ "quick-xml 0.17.2",
  "serde 1.0.114",
  "zip",
 ]
@@ -2477,6 +2477,7 @@ dependencies = [
  "nu_plugin_to_sqlite",
  "nu_plugin_tree",
  "pretty_env_logger",
+ "quick-xml 0.18.1",
  "semver 0.10.0",
  "serde 1.0.114",
  "starship",
@@ -2554,6 +2555,7 @@ dependencies = [
  "pretty_env_logger",
  "ptree",
  "query_interface",
+ "quick-xml 0.18.1",
  "quickcheck",
  "quickcheck_macros",
  "rand",
@@ -3528,6 +3530,15 @@ dependencies = [
  "memchr",
 ]
 
+[[package]]
+name = "quick-xml"
+version = "0.18.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3cc440ee4802a86e357165021e3e255a9143724da31db1e2ea540214c96a0f82"
+dependencies = [
+ "memchr",
+]
+
 [[package]]
 name = "quickcheck"
 version = "0.9.2"

Cargo.toml

@@ -52,6 +52,7 @@ futures = {version = "0.3", features = ["compat", "io-compat"]}
 log = "0.4.8"
 pretty_env_logger = "0.4.0"
 starship = "0.43.0"
+quick-xml = "0.18.1"
 
 [dev-dependencies]
 nu-test-support = {version = "0.17.0", path = "./crates/nu-test-support"}

crates/nu-cli/Cargo.toml

@@ -93,6 +93,7 @@ encoding_rs = "0.8.23"
 rayon = "1.3.1"
 starship = {version = "0.43.0", optional = true}
 trash = {version = "1.0.1", optional = true}
+quick-xml = "0.18.1"
 
 [target.'cfg(unix)'.dependencies]
 users = "0.10.0"

crates/nu-cli/src/cli.rs

@@ -384,6 +384,7 @@ pub fn create_default_context(
             whole_stream_command(ToTSV),
             whole_stream_command(ToURL),
             whole_stream_command(ToYAML),
+            whole_stream_command(ToXML),
             // File format input
             whole_stream_command(From),
             whole_stream_command(FromCSV),

crates/nu-cli/src/commands.rs

@@ -109,6 +109,7 @@ pub(crate) mod to_md;
 pub(crate) mod to_toml;
 pub(crate) mod to_tsv;
 pub(crate) mod to_url;
+pub(crate) mod to_xml;
 pub(crate) mod to_yaml;
 pub(crate) mod trim;
 pub(crate) mod uniq;
@@ -238,6 +239,7 @@ pub(crate) use to_md::ToMarkdown;
 pub(crate) use to_toml::ToTOML;
 pub(crate) use to_tsv::ToTSV;
 pub(crate) use to_url::ToURL;
+pub(crate) use to_xml::ToXML;
 pub(crate) use to_yaml::ToYAML;
 pub(crate) use touch::Touch;
 pub(crate) use trim::Trim;

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

@@ -0,0 +1,205 @@
+use crate::commands::WholeStreamCommand;
+use crate::prelude::*;
+use indexmap::IndexMap;
+use nu_errors::ShellError;
+use nu_protocol::{Primitive, ReturnSuccess, Signature, SyntaxShape, UntaggedValue, Value};
+use quick_xml::events::{BytesEnd, BytesStart, BytesText, Event};
+use std::collections::HashSet;
+use std::io::Cursor;
+use std::io::Write;
+use std::iter::FromIterator;
+
+pub struct ToXML;
+
+#[derive(Deserialize)]
+pub struct ToXMLArgs {
+    pretty: Option<Value>,
+}
+
+#[async_trait]
+impl WholeStreamCommand for ToXML {
+    fn name(&self) -> &str {
+        "to xml"
+    }
+
+    fn signature(&self) -> Signature {
+        Signature::build("to xml").named(
+            "pretty",
+            SyntaxShape::Int,
+            "Formats the XML text with the provided indentation setting",
+            Some('p'),
+        )
+    }
+
+    fn usage(&self) -> &str {
+        "Convert table into .xml text"
+    }
+
+    async fn run(
+        &self,
+        args: CommandArgs,
+        registry: &CommandRegistry,
+    ) -> Result<OutputStream, ShellError> {
+        to_xml(args, registry).await
+    }
+}
+
+pub fn add_attributes<'a>(
+    element: &mut quick_xml::events::BytesStart<'a>,
+    attributes: &'a IndexMap<String, String>,
+) {
+    for (k, v) in attributes.iter() {
+        element.push_attribute((k.as_str(), v.as_str()));
+    }
+}
+
+pub fn get_attributes(row: &Value) -> Option<IndexMap<String, String>> {
+    if let UntaggedValue::Row(r) = &row.value {
+        if let Some(v) = r.entries.get("attributes") {
+            if let UntaggedValue::Row(a) = &v.value {
+                let mut h = IndexMap::new();
+                for (k, v) in a.entries.iter() {
+                    h.insert(k.clone(), v.convert_to_string());
+                }
+                return Some(h);
+            }
+        }
+    }
+    None
+}
+
+pub fn get_children(row: &Value) -> Option<&Vec<Value>> {
+    if let UntaggedValue::Row(r) = &row.value {
+        if let Some(v) = r.entries.get("children") {
+            if let UntaggedValue::Table(t) = &v.value {
+                return Some(t);
+            }
+        }
+    }
+    None
+}
+
+pub fn is_xml_row(row: &Value) -> bool {
+    if let UntaggedValue::Row(r) = &row.value {
+        let keys: HashSet<&String> = HashSet::from_iter(r.keys());
+        let children: String = "children".to_string();
+        let attributes: String = "attributes".to_string();
+        return keys.contains(&children) && keys.contains(&attributes) && keys.len() == 2;
+    }
+    false
+}
+
+pub fn write_xml_events<W: Write>(
+    current: &Value,
+    writer: &mut quick_xml::Writer<W>,
+) -> Result<(), ShellError> {
+    match &current.value {
+        UntaggedValue::Row(o) => {
+            for (k, v) in o.entries.iter() {
+                let mut e = BytesStart::owned(k.as_bytes(), k.len());
+                if !is_xml_row(v) {
+                    return Err(ShellError::labeled_error(
+                        "Expected a row with 'children' and 'attributes' columns",
+                        "missing 'children' and 'attributes' columns ",
+                        &current.tag,
+                    ));
+                }
+                let a = get_attributes(v);
+                if let Some(ref a) = a {
+                    add_attributes(&mut e, a);
+                }
+                writer
+                    .write_event(Event::Start(e))
+                    .expect("Couldn't open XML node");
+                let c = get_children(v);
+                if let Some(c) = c {
+                    for v in c {
+                        write_xml_events(v, writer)?;
+                    }
+                }
+                writer
+                    .write_event(Event::End(BytesEnd::borrowed(k.as_bytes())))
+                    .expect("Couldn't close XML node");
+            }
+        }
+        UntaggedValue::Table(t) => {
+            for v in t {
+                write_xml_events(v, writer)?;
+            }
+        }
+        _ => {
+            let s = current.convert_to_string();
+            writer
+                .write_event(Event::Text(BytesText::from_plain_str(s.as_str())))
+                .expect("Couldn't write XML text");
+        }
+    }
+    Ok(())
+}
+
+async fn to_xml(args: CommandArgs, registry: &CommandRegistry) -> Result<OutputStream, ShellError> {
+    let registry = registry.clone();
+    let name_tag = args.call_info.name_tag.clone();
+    let name_span = name_tag.span;
+    let (ToXMLArgs { pretty }, input) = args.process(&registry).await?;
+    let input: Vec<Value> = input.collect().await;
+
+    let to_process_input = match input.len() {
+        x if x > 1 => {
+            let tag = input[0].tag.clone();
+            vec![Value {
+                value: UntaggedValue::Table(input),
+                tag,
+            }]
+        }
+        1 => input,
+        _ => vec![],
+    };
+
+    Ok(
+        futures::stream::iter(to_process_input.into_iter().map(move |value| {
+            let mut w = pretty.as_ref().map_or_else(
+                || quick_xml::Writer::new(Cursor::new(Vec::new())),
+                |p| {
+                    quick_xml::Writer::new_with_indent(
+                        Cursor::new(Vec::new()),
+                        b' ',
+                        p.value.expect_int() as usize,
+                    )
+                },
+            );
+
+            let value_span = value.tag.span;
+
+            match write_xml_events(&value, &mut w) {
+                Ok(_) => {
+                    let b = w.into_inner().into_inner();
+                    let s = String::from_utf8(b)?;
+                    ReturnSuccess::value(
+                        UntaggedValue::Primitive(Primitive::String(s)).into_value(&name_tag),
+                    )
+                }
+                Err(_) => Err(ShellError::labeled_error_with_secondary(
+                    "Expected a table with XML-compatible structure from pipeline",
+                    "requires XML-compatible input",
+                    name_span,
+                    "originates from here".to_string(),
+                    value_span,
+                )),
+            }
+        }))
+        .to_output_stream(),
+    )
+}
+
+#[cfg(test)]
+mod tests {
+    use super::ToXML;
+
+    #[test]
+    fn examples_work_as_expected() {
+        use crate::examples::test as test_examples;
+
+        test_examples(ToXML {})
+    }
+}

crates/nu-cli/tests/format_conversions/mod.rs

@@ -13,4 +13,5 @@ mod tsv;
 mod url;
 mod vcf;
 mod xlsx;
+mod xml;
 mod yaml;

crates/nu-cli/tests/format_conversions/xml.rs

@@ -0,0 +1,17 @@
+use nu_test_support::{nu, pipeline};
+
+#[test]
+fn table_to_xml_text_and_from_xml_text_back_into_table() {
+    let actual = nu!(
+        cwd: "tests/fixtures/formats", pipeline(
+        r#"
+            open jonathan.xml
+            | to xml
+            | from xml
+            | get rss.children.channel.children.0.item.children.0.guid.attributes.isPermaLink
+            | echo $it
+        "#
+    ));
+
+    assert_eq!(actual.out, "true");
+}

crates/nu-errors/src/lib.rs

@@ -833,6 +833,18 @@ impl std::convert::From<std::io::Error> for ShellError {
     }
 }
 
+impl std::convert::From<std::string::FromUtf8Error> for ShellError {
+    fn from(input: std::string::FromUtf8Error) -> ShellError {
+        ShellError::untagged_runtime_error(format!("{}", input))
+    }
+}
+
+impl std::convert::From<std::str::Utf8Error> for ShellError {
+    fn from(input: std::str::Utf8Error) -> ShellError {
+        ShellError::untagged_runtime_error(format!("{}", input))
+    }
+}
+
 impl std::convert::From<serde_yaml::Error> for ShellError {
     fn from(input: serde_yaml::Error) -> ShellError {
         ShellError::untagged_runtime_error(format!("{:?}", input))

docs/commands/to-xml.md

@@ -0,0 +1,76 @@
+# to xml
+
+Converts table data into XML text.
+
+## Flags
+
+-   `-p`, `--pretty` \<integer>: Formats the XML text with the provided indentation setting
+
+## Example
+
+```shell
+> open jonathan.xml
+━━━━━━━━━━━━━━━━
+ rss
+────────────────
+ [table: 1 row]
+━━━━━━━━━━━━━━━━
+```
+
+```shell
+> cat jonathan.xml
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/">
+        <channel>
+                <title>Jonathan Turner</title>
+                <link>http://www.jonathanturner.org</link>
+                <atom:link href="http://www.jonathanturner.org/feed.xml" rel="self" type="application/rss+xml" />
+
+                        <item>
+                                <title>Creating crossplatform Rust terminal apps</title>
+        <description>&lt;p&gt;&lt;img src=&quot;/images/pikachu.jpg&quot; alt=&quot;Pikachu animation in Windows&quot; /&gt;&lt;/p&gt;
+
+&lt;p&gt;&lt;em&gt;Look Mom, Pikachu running in Windows CMD!&lt;/em&gt;&lt;/p&gt;
+
+&lt;p&gt;Part of the adventure is not seeing the way ahead and going anyway.&lt;/p&gt;
+</description>
+<pubDate>Mon, 05 Oct 2015 00:00:00 +0000</pubDate>
+<link>http://www.jonathanturner.org/2015/10/off-to-new-adventures.html</link>
+<guid isPermaLink="true">http://www.jonathanturner.org/2015/10/off-to-new-adventures.html</guid>
+</item>
+
+        </channel>
+
+</rss>
+```
+
+```shell
+> open jonathan.xml | to xml --pretty 2
+<rss version="2.0">
+  <channel>
+    <title>Jonathan Turner</title>
+    <link>http://www.jonathanturner.org</link>
+    <link href="http://www.jonathanturner.org/feed.xml" rel="self" type="application/rss+xml">
+    </link>
+    <item>
+      <title>Creating crossplatform Rust terminal apps</title>
+      <description>&lt;p&gt;&lt;img src=&quot;/images/pikachu.jpg&quot; alt=&quot;Pikachu animation in Windows&quot; /&gt;&lt;/p&gt;
+
+&lt;p&gt;&lt;em&gt;Look Mom, Pikachu running in Windows CMD!&lt;/em&gt;&lt;/p&gt;
+
+&lt;p&gt;Part of the adventure is not seeing the way ahead and going anyway.&lt;/p&gt;
+</description>
+<pubDate>Mon, 05 Oct 2015 00:00:00 +0000</pubDate>
+<link>http://www.jonathanturner.org/2015/10/off-to-new-adventures.html</link>
+<guid isPermaLink="true">http://www.jonathanturner.org/2015/10/off-to-new-adventures.html</guid>
+</item>
+</channel>
+</rss>
+```
+
+Due to XML and internal representation, `to xml` is currently limited, it will:
+
+-   only process table data loaded from XML files (e.g. `open file.json | to xml` will fail)
+-   drop XML prolog declarations
+-   drop namespaces
+-   drop comments