Merge pull request #631 from RcppCore/feature/bib_file

Feature/bib file

Author: eddelbuettel

ChangeLog

@@ -1,3 +1,18 @@
+2017-01-12  Dirk Eddelbuettel  <[email protected]>
+
+        * inst/bib/Rcpp.bib: Moved from vignettes/ directory
+        * R/bib.R (bib): Idem
+
+        * vignettes/Rcpp-FAQ.Rnw: Evaluate \Sexpr{Rcpp:::bib()}
+        * vignettes/Rcpp-attributes.Rnw: Idem
+        * vignettes/Rcpp-extending.Rnw: Idem
+        * vignettes/Rcpp-introduction.Rnw: Idem
+        * vignettes/Rcpp-modules.Rnw: Idem
+        * vignettes/Rcpp-packages.Rnw: Idem
+        * vignettes/Rcpp-sugar.Rnw: Idem
+
+        * inst/unitTests/runit.misc.R (test.bib): New test
+
 2017-01-11  Dirk Eddelbuettel  <[email protected]>
 
         * vignettes/Rcpp.bib: Updated references

R/bib.R

@@ -1,4 +1,4 @@
-# Copyright (C) 2010 - 2012  Dirk Eddelbuettel and Romain Francois
+# Copyright (C) 2010 - 2017  Dirk Eddelbuettel and Romain Francois
 #
 # This file is part of Rcpp.
 #
@@ -16,5 +16,5 @@
 # along with Rcpp.  If not, see <http://www.gnu.org/licenses/>.
 
 bib <- function() {
-    sub("\\.bib$", "", system.file( "doc", "Rcpp.bib", package = "Rcpp" ) )
+    sub("\\.bib$", "", system.file("bib", "Rcpp.bib", package = "Rcpp"))
 }

inst/NEWS.Rd

@@ -32,6 +32,8 @@
     \itemize{
       \item Exposed pointers macros were included in the Rcpp Extending vignette
       (MathurinD; James Balamuta in \ghpr{592} addressing \ghit{418}).
+      \item The file \code{Rcpp.bib} move to directory \code{bib} which is
+      guaranteed to be present.
     }
     \item Changes in Rcpp build system
     \itemize{

vignettes/Rcpp.bib renamed to inst/bib/Rcpp.bib

@@ -1,6 +1,6 @@
 #!/usr/bin/env r
 #
-# Copyright (C) 2010 - 2015  Dirk Eddelbuettel and Romain Francois
+# Copyright (C) 2010 - 2017  Dirk Eddelbuettel and Romain Francois
 #
 # This file is part of Rcpp.
 #
@@ -98,78 +98,78 @@ if (.runThisTest) {
     }
 
     test.AreMacrosDefined <- function(){
-        checkTrue( Rcpp:::areMacrosDefined( "__cplusplus" ) )    
+        checkTrue( Rcpp:::areMacrosDefined( "__cplusplus" ) )
     }
-    
+
     test.rcout <- function(){
         ## define test string that is written to two files
         teststr <- "First line.\nSecond line."
 
         rcppfile <- tempfile()
         rfile <- tempfile()
-        
+
         ## write to test_rcpp.txt from Rcpp
         test_rcout(rcppfile,  teststr )
-        
+
         ## write to test_r.txt from R
         cat( teststr, file=rfile, sep='\n' )
-        
+
         ## compare whether the two files have the same data
-        checkEquals( readLines(rcppfile), readLines(rfile), msg="Rcout output")    
+        checkEquals( readLines(rcppfile), readLines(rfile), msg="Rcout output")
     }
 
     test.rcout.complex <- function(){
 
         rcppfile <- tempfile()
         rfile <- tempfile()
-        
+
         z <- complex(real=sample(1:10, 1), imaginary=sample(1:10, 1))
-        
+
         ## write to test_rcpp.txt from Rcpp
         test_rcout_rcomplex(rcppfile,  z )
-        
+
         ## write to test_r.txt from R
         cat( z, file=rfile, sep='\n' )
-        
+
         ## compare whether the two files have the same data
-        checkEquals( readLines(rcppfile), readLines(rfile), msg="Rcout Rcomplex")    
+        checkEquals( readLines(rcppfile), readLines(rfile), msg="Rcout Rcomplex")
     }
 
     test.na_proxy <- function(){
-        checkEquals( 
-            na_proxy(), 
-            rep(c(TRUE,TRUE,TRUE,FALSE,FALSE,FALSE,FALSE,FALSE,FALSE) , 2), 
+        checkEquals(
+            na_proxy(),
+            rep(c(TRUE,TRUE,TRUE,FALSE,FALSE,FALSE,FALSE,FALSE,FALSE) , 2),
             msg = "Na_Proxy NA == handling"
-            )    
+            )
     }
 
     test.StretchyList <- function(){
-        checkEquals( 
+        checkEquals(
             stretchy_list(),
             pairlist( "foo", 1L, 3.2 )
             )
     }
 
     test.named_StretchyList <- function(){
-        checkEquals( 
+        checkEquals(
             named_stretchy_list(),
             pairlist( a = "foo", b = 1L, c = 3.2 )
             )
     }
-    
+
     test.stop.variadic <- function(){
         m <- tryCatch( test_stop_variadic(), error = function(e){
-            conditionMessage(e)  
+            conditionMessage(e)
         })
-        checkEquals( m, "foo 3" ) 
+        checkEquals( m, "foo 3" )
     }
 
     test.NullableForNull <- function() {
         M <- matrix(1:4, 2, 2)
         checkTrue(   testNullableForNull(NULL) )
         checkTrue( ! testNullableForNull(M) )
     }
-    
+
     test.NullableForNotNull <- function() {
         M <- matrix(1:4, 2, 2)
         checkTrue( ! testNullableForNotNull(NULL) )
@@ -180,7 +180,7 @@ if (.runThisTest) {
         M <- matrix(1:4, 2, 2)
         checkEquals( testNullableOperator(M), M )
     }
-    
+
     test.NullableAccessGet <- function() {
         M <- matrix(1:4, 2, 2)
         checkEquals( testNullableGet(M), M )
@@ -209,4 +209,9 @@ if (.runThisTest) {
         checkEquals(testNullableString(), "")
         checkEquals(testNullableString("blah"), "blah")
     }
+
+    test.bib <- function() {
+        checkTrue(nchar(Rcpp:::bib()) > 0, msg="bib file")
+    }
+
 }

inst/unitTests/runit.misc.R

@@ -1329,7 +1329,6 @@ We have since switched to a \href{http://github.com/RcppCore/Rcpp}{Git
 \pkg{RcppEigen}).
 
 \bibliographystyle{plainnat}
-\bibliography{Rcpp}
-
+\bibliography{\Sexpr{Rcpp:::bib()}}
 \end{document}
 

vignettes/Rcpp-FAQ.Rnw

@@ -823,7 +823,7 @@ when headers in \texttt{inst/include} change, so you should be sure to perform a
 full rebuild of the package after making changes to these headers.
 
 \bibliographystyle{plainnat}
-\bibliography{Rcpp}
+\bibliography{\Sexpr{Rcpp:::bib()}}
 
 \end{document}
 

vignettes/Rcpp-attributes.Rnw

@@ -367,7 +367,7 @@ to either user-defined or third-party classes via the \texttt{Rcpp::as} and
 approaches were discussed.
 
 \bibliographystyle{plainnat}
-\bibliography{Rcpp}
+\bibliography{\Sexpr{Rcpp:::bib()}}
 
 \end{document}
 

vignettes/Rcpp-extending.Rnw

@@ -1064,7 +1064,7 @@ Ligges, Brian Ripley and Simon Urbanek concerning the build systems for differen
 platforms.   Last but not least, several users provided very fruitful
 ideas for new or extended features via the \code{rcpp-devel} mailing list.
 
-\bibliography{Rcpp}
+\bibliography{\Sexpr{Rcpp:::bib()}}
 
 \vspace*{-0.35cm}
 

vignettes/Rcpp-introduction.Rnw

@@ -1047,7 +1047,7 @@ We hope that \proglang{R} and \proglang{C++} programmers
 find \textsl{Rcpp modules} useful.
 
 \bibliographystyle{plainnat}
-\bibliography{Rcpp}
+\bibliography{\Sexpr{Rcpp:::bib()}}
 
 \end{document}