Improve warning when formatting unknown macros; closes #49

Author: mwmclean

R/format.R

@@ -44,15 +44,27 @@ format.BibEntry <- function(x, style = .BibOptions$style,
           on.exit(close(con))
           ## macro.env <- tools::loadRdMacros(file.path(R.home("share"), "Rd",
           ##                                            "macros", "system.Rd"))
+          warnWithKey <- function(w){
+                                           msg <- sub("^.*[[:alnum:]][:] ", "", w)
+                                           msg <- paste0(y$key, ": ", msg)
+                                           warning(msg, call. = FALSE)
+                                           invokeRestart("muffleWarning")
+                                       }
           if (getRversion() >= "3.3.0"){
             ## !!! prevent use of devtools::system.file
             macro.env <- tools::loadPkgRdMacros(base::system.file(package =
                                                                 "RefManageR"))
-            f(con, fragment = TRUE, out = out, outputEncoding = 'UTF-8',
-              macros = macro.env, ...) 
+              withCallingHandlers(f(con, fragment = TRUE, out = out,
+                         outputEncoding = 'UTF-8', macros = macro.env,
+                         warningCalls = FALSE, ...),
+                         warning = warnWithKey)
+              ## suppressWarnings(f(con, fragment = TRUE, out = out,
+              ##                        outputEncoding = 'UTF-8', macros = macro.env, ...))
           }else
-              f(con, fragment = TRUE, out = out, outputEncoding = 'UTF-8', ...)
-              
+              withCallingHandlers(f(con, fragment = TRUE, out = out,
+                         outputEncoding = 'UTF-8', warningCalls = FALSE, ...),
+                         warning = warnWithKey)
+
           paste(readLines(out, encoding = 'UTF-8'), collapse = "\n")
         }, "")
         if (style == "html"){

inst/NEWS.md

@@ -1,9 +1,13 @@
 Changes in Version 1.2.0 (2018-04-24)
 --------------------------------------------------------
 
+NEW FEATURES
+
 * `+.BibEntry` and `merge.BibEntry` gain an argument ignore.case,
 which defaults to `BibOptions()$ignore.case` (`TRUE`) so that case is 
 ignore when checking for duplicate fields (h/t Justin Calabrese #47)
+* Improved warning message when printing entries with unknown 
+LaTeX macros (the entry key is now included). (h/t Justin Calabrese #49)
 
 
 Changes in Version 1.1.0 (2018-04-02)

tests/testthat/test-methods.R

@@ -90,6 +90,13 @@ test_that("open", {
     open(testbib, entry = 1)  # eprint
 })
 
+test_that("Warning for unknown macro includes key",
+{
+    bib <- BibEntry(key = "testkey", bibtype = "misc", author = "Smith, John",
+                    title = "Title with \\badmacro", year = 2018)
+    expect_warning(print(bib), "^testkey: unknown macro")
+})
+
 test_that("c", {
    expect_length(c(bib[1], bib[2]), 2L)
    expect_error(c(bib[1], unlist(bib[2])))