Removed tectonic show metadata

Author: rm-dr

crates/docmodel/src/document.rs

@@ -49,13 +49,6 @@ pub struct Document {
     /// this will be a subdirectory of `src_dir` named `build`.
     build_dir: PathBuf,
 
-    /// Arbitrary document metadata.
-    /// This has no effect on tectonic's build process.
-    /// Rather, allows users to add easily-accessible information to their documents.
-    ///
-    /// Tectonic's `show metadata` command displays this information.
-    pub metadata: Option<toml::Value>,
-
     /// The document name. This will be used to name build artifacts and the
     /// like, and so should be relatively filesystem-friendly. It does not
     /// need to be the same as the document title.
@@ -110,7 +103,6 @@ impl Document {
             build_dir: build_dir.into(),
             name: doc.doc.name,
             bundle_loc: doc.doc.bundle,
-            metadata: doc.doc.metadata,
             outputs,
         })
     }
@@ -132,7 +124,7 @@ impl Document {
             doc: syntax::DocSection {
                 name: self.name.clone(),
                 bundle: self.bundle_loc.clone(),
-                metadata: None,
+                metadata: serde::de::IgnoredAny{},
             },
             outputs,
         };
@@ -297,7 +289,6 @@ impl Document {
             name,
             bundle_loc,
             outputs: crate::document::default_outputs(),
-            metadata: None,
         })
     }
 }
@@ -339,7 +330,9 @@ mod syntax {
     pub struct DocSection {
         pub name: String,
         pub bundle: String,
-        pub metadata: Option<toml::Value>,
+
+        #[serde(skip_serializing)]
+        pub metadata: serde::de::IgnoredAny,
     }
 
     #[derive(Debug, Deserialize, Serialize)]

docs/src/ref/tectonic-toml.md

@@ -17,6 +17,14 @@ the file are detailed below.
 name = <string>  # the document name
 bundle = <url or filesystem path>  # the source of the TeX bundle
 
+# The doc.metadata table may contain arbitrary data.
+# It does not affect Tectonic in any way.
+[doc.metadata]
+pubish = false
+arr = [1, 2, [6, 7]]
+
+
+
 [[output]]  # one or more output specifications
 name = <string>  # the output's name
 type = <"pdf">  # the output's type
@@ -50,6 +58,12 @@ or a directory of support files. This mode of operation is discouraged because
 it limits reproducibility. URLs with a `file:` protocol are also treated
 identically to filesystem paths.
 
+### `doc.metadata`
+
+Arbitrary metadata, not read by Tectonic. This table allows us to
+save parameters for external scripts without creating an extra file.
+
+
 ### `output`
 
 A list of dictionaries defining different outputs to be created from the

docs/src/v2cli/show.md

@@ -726,23 +726,18 @@ enum ShowCommands {
     #[structopt(name = "user-cache-dir")]
     /// Print the location of the default per-user cache directory
     UserCacheDir(ShowUserCacheDirCommand),
-
-    /// Show metadata from the current environment
-    Metadata(ShowMetadataCommand),
 }
 
 impl ShowCommand {
     fn customize(&self, cc: &mut CommandCustomizations) {
         match &self.command {
             ShowCommands::UserCacheDir(c) => c.customize(cc),
-            ShowCommands::Metadata(c) => c.customize(cc),
         }
     }
 
     fn execute(self, config: PersistentConfig, status: &mut dyn StatusBackend) -> Result<i32> {
         match self.command {
             ShowCommands::UserCacheDir(c) => c.execute(config, status),
-            ShowCommands::Metadata(c) => c.execute(config, status),
         }
     }
 }
@@ -762,111 +757,3 @@ impl ShowUserCacheDirCommand {
         Ok(0)
     }
 }
-
-#[derive(Debug, Eq, PartialEq, StructOpt)]
-struct ShowMetadataCommand {
-    #[structopt(help = "The metadata key to get")]
-    key: String,
-}
-
-
-fn get_metadata(meta: &toml::Value, mut parts: core::str::Split<&str>) -> Option<String> {
-    match meta {
-        toml::Value::String(_)
-        | toml::Value::Boolean(_)
-        | toml::Value::Integer(_)
-        | toml::Value::Float(_)
-        | toml::Value::Datetime(_) => {
-            if parts.next().is_some() {
-                // None of these types may be indexed further
-                return None;
-            }
-
-            return Some(match meta {
-                toml::Value::String(s) => s.clone(),
-                toml::Value::Datetime(d) => format!("{}", d),
-                _ => format!("{}", meta),
-            });
-        }
-
-        toml::Value::Array(a) => {
-            match parts.next() {
-                None => return None,
-                Some(s) => {
-                    if s == "len" {
-                        // Magic key to get array length.
-                        // Allows easy iteration.
-                        return Some(format!("{}", a.len()));
-                    } else {
-                        let i: usize = match s.parse() {
-                            Ok(i) => i,
-                            Err(_) => return None,
-                        };
-
-                        let meta = match a.get(i) {
-                            Some(v) => v,
-                            None => return None,
-                        };
-
-                        return get_metadata(meta, parts);
-                    }
-                }
-            }
-        }
-
-        toml::Value::Table(t) => {
-            match parts.next() {
-                None => return None,
-                Some(s) => {
-                    let meta = match t.get(s) {
-                        Some(v) => v,
-                        None => return None,
-                    };
-
-                    return get_metadata(meta, parts);
-                }
-            }
-        }
-    };
-}
-
-
-
-impl ShowMetadataCommand {
-    fn customize(&self, cc: &mut CommandCustomizations) {
-        cc.always_stderr = true;
-    }
-
-    fn execute(self, _config: PersistentConfig, _status: &mut dyn StatusBackend) -> Result<i32> {
-        // `tectonic show metadata` should be as shell-script-friendly as possible.
-        // It should either print a value or return an error code, and produce NO OTHER OUTPUT.
-        //
-        // We return code 1 if `key` doesn't exist
-        // We return code 2 if we can't open a workspace.
-
-        let meta = match Workspace::open_from_environment() {
-            Ok(ws) => {
-                let doc = ws.first_document();
-                let meta = doc.metadata.clone();
-                if meta.is_none() {
-                    return Ok(1);
-                }
-                meta.unwrap()
-            }
-
-            Err(_) => {
-                return Ok(2);
-            }
-        };
-
-        let parts = self.key.split(".");
-
-        let meta = get_metadata(&meta, parts);
-        if meta.is_none() {
-            return Ok(1);
-        }
-
-        println!("{}", meta.unwrap());
-        Ok(0)
-    }
-}