Merge pull request #599 from RcppCore/feature/format_dates

added format() methods for Date and Datetime

Author: eddelbuettel

ChangeLog

@@ -1,9 +1,27 @@
+2016-11-28  Dirk Eddelbuettel  <[email protected]>
+
+        * inst/unitTests/cpp/dates.cpp (Date_format, Datetime_format): New tests
+        * inst/unitTests/runit.Date.R (test.Date.formating): Ditto
+        (test.Datetime.formating): Ditto
+
+2016-11-27  Dirk Eddelbuettel  <[email protected]>
+
+        * inst/include/Rcpp/date_datetime/Date.h (format, operator<<): Added
+        * inst/include/Rcpp/date_datetime/Datetime.h (format, operator<<): Ditto
+        * inst/include/Rcpp/date_datetime/newDateVector.h (operator<<): Ditto
+        * inst/include/Rcpp/date_datetime/newDatetimeVector.h (operator<<): Ditto
+
+2016-11-23  Dirk Eddelbuettel  <[email protected]>
+
+        * inst/include/Rcpp/config.h (RCPP_DEV_VERSION): Set minor version
+
 2016-11-22  Dirk Eddelbuettel  <[email protected]>
 
         * DESCRIPTION (Date, Version): roll minor version
 
         * inst/include/Rcpp/date_datetime/newDatetimeVector.h (Rcpp): Small
         correction concerning timezone attribute to ctor from RTYPE
+
 2016-11-22  Jim Hester  <[email protected]>
 
         * inst/src/api.cpp: Cleanup to stack message parseing

inst/NEWS.Rd

@@ -4,10 +4,13 @@
 \newcommand{\ghit}{\href{https://github.com/RcppCore/Rcpp/issues/#1}{##1}}
 
 \section{Changes in Rcpp version 0.12.9 (2017-01-xx)}{
+  \itemize{
     \item Changes in Rcpp API:
     \itemize{
       \item The exception stack message is now correctly demangled on all
       compiler versions (Jim Hester in \ghpr{598})
+      \item Date and Datetime object and vector now have format methods and
+      \code{operator<<} support (PR\ghpr{599})
     }
     \item Changes in Rcpp unit tests
     \itemize{
@@ -17,8 +20,9 @@
     \item Changes in Rcpp Documentation:
     \itemize{
       \item Exposed pointers macros were included in the Rcpp Extending vignette
-       (MathurinD; James Balamuta in \ghpr{592} addressing \ghit{418}).
+      (MathurinD; James Balamuta in \ghpr{592} addressing \ghit{418}).
     }
+  }
 }
 
 \section{Changes in Rcpp version 0.12.8 (2016-11-16)}{

inst/include/Rcpp/config.h

@@ -30,7 +30,7 @@
 #define RCPP_VERSION Rcpp_Version(0,12,8)
 
 // the current source snapshot
-#define RCPP_DEV_VERSION RcppDevVersion(0,12,8,0)
+#define RCPP_DEV_VERSION RcppDevVersion(0,12,8,1)
 
 #endif
 

inst/include/Rcpp/date_datetime/Date.h

@@ -102,6 +102,20 @@ namespace Rcpp {
             return m_d;
         }
 
+        inline std::string format(const char *fmt = "%Y-%m-%d") const {
+            char txt[32];
+            struct tm temp = m_tm;
+            temp.tm_year -= baseYear();    // adjust for fact that system has year rel. to 1900
+            int res = ::strftime(txt, 31, fmt, &temp);
+            if (res == 0) {
+                return std::string("");
+            } else {
+                return std::string(txt);
+            }
+        }
+
+        friend inline std::ostream &operator<<(std::ostream & os, const Date d);
+
     private:
         double m_d;                 // (fractional) day number, relative to epoch of Jan 1, 1970
         struct tm m_tm;             // standard time representation
@@ -153,6 +167,11 @@ namespace Rcpp {
     inline bool   operator<=(const Date &d1, const Date& d2) { return d1.m_d <= d2.m_d; }
     inline bool   operator!=(const Date &d1, const Date& d2) { return d1.m_d != d2.m_d; }
 
+    inline std::ostream &operator<<(std::ostream & os, const Date d) {
+        os << d.format();
+        return os;
+    }
+
     namespace internal {
 
         inline SEXP getPosixClasses() {

inst/include/Rcpp/date_datetime/Datetime.h

@@ -68,6 +68,25 @@ namespace Rcpp {
 
         operator double()  const { return m_dt; }
 
+        inline std::string format(const char *fmt = "%Y-%m-%d %H:%M:%S") const {
+            char txtiso[64], txtsec[64];
+            time_t t = static_cast<time_t>(std::floor(m_dt));
+            struct tm temp = *localtime(&t); // localtime, not gmtime
+            int res = ::strftime(txtiso, 63, fmt, &temp);
+            if (res == 0) {
+                return std::string("");
+            } else {
+                res = ::snprintf(txtsec, 63, "%s.%06d", txtiso, m_us);
+                if (res <= 0) {
+                    return std::string("");
+                } else {
+                    return std::string(txtsec);
+                }
+            }
+        }
+
+        friend inline std::ostream &operator<<(std::ostream & s, const Datetime d);
+
     private:
         double m_dt;            // fractional seconds since epoch
         struct tm m_tm;         // standard time representation
@@ -88,6 +107,11 @@ namespace Rcpp {
             }
         }
 
+        // 1900 as per POSIX mktime() et al
+        static inline unsigned int baseYear() {
+            return 1900;
+        }
+
     };
 
 
@@ -132,6 +156,11 @@ namespace Rcpp {
     inline bool    operator<=(const Datetime &d1, const Datetime& d2) { return d1.m_dt <= d2.m_dt; }
     inline bool    operator!=(const Datetime &d1, const Datetime& d2) { return d1.m_dt != d2.m_dt; }
 
+    inline std::ostream &operator<<(std::ostream & os, const Datetime d) {
+        os << d.format();
+        return os;
+    }
+
 }
 
 #endif

inst/include/Rcpp/date_datetime/newDateVector.h

@@ -52,13 +52,24 @@ namespace Rcpp {
             return *this;
         }
 
+        friend inline std::ostream &operator<<(std::ostream & s, const newDateVector d);
+
     private:
 
         void setClass() {
             Shield<SEXP> dateclass(Rf_mkString("Date"));
             Rf_setAttrib(*this, R_ClassSymbol, dateclass);
         }
     };
+
+    inline std::ostream &operator<<(std::ostream & os, const newDateVector d) {
+        int n = d.size();
+        for (int i=0; i<n; i++) {
+            os << Date(d[i]).format() << " ";
+            if ((i+1) % 8 == 0) os << "\n";
+        }
+        return os;
+    }
 }
 
 #endif

inst/include/Rcpp/date_datetime/newDatetimeVector.h

@@ -61,6 +61,8 @@ namespace Rcpp {
             return *this;
         }
 
+        friend inline std::ostream &operator<<(std::ostream & s, const newDatetimeVector d);
+
     private:
 
         void setClass(const char *tz) {
@@ -75,6 +77,16 @@ namespace Rcpp {
             }
         }
     };
+
+    inline std::ostream &operator<<(std::ostream & os, const newDatetimeVector d) {
+        int n = d.size();
+        for (int i=0; i<n; i++) {
+            os << Datetime(d[i]).format() << " ";
+            if ((i+1) % 4 == 0) os << "\n";
+        }
+        return os;
+    }
+
 }
 
 #endif

inst/unitTests/cpp/dates.cpp

@@ -171,4 +171,14 @@ DatetimeVector DatetimeVector_assignment(DatetimeVector v1,
 DateVector DateVector_assignment(DateVector v1, DateVector v2) {
     v1 = v2;
     return v1;
-}
+}
+
+// [[Rcpp::export]]
+std::string Date_format(Date d, std::string fmt) {
+    return d.format(fmt.c_str());
+}
+
+// [[Rcpp::export]]
+std::string Datetime_format(Datetime d, std::string fmt) {
+    return d.format(fmt.c_str());
+}

inst/unitTests/runit.Date.R

@@ -181,19 +181,56 @@ if (.runThisTest) {
             checkEquals(fun(vec), c(now, rep(posixtNA, 3), now+2.345), msg = "Datetime.ctor.NA.NaN.Inf.set")
         }
     }
-    
+
     test.DatetimeVector.assignment <- function() {
         now <- Sys.time()
         v1 <- c(now, now + 1, now + 2)
         v2 <- c(now + 3, now + 4, now + 5)
         checkEquals(v2, DatetimeVector_assignment(v1, v2))
     }
-    
+
     test.DateVector.assignment <- function() {
         now <- Sys.Date()
         v1 <- c(now, now + 1, now + 2)
         v2 <- c(now + 3, now + 4, now + 5)
         checkEquals(v2, DateVector_assignment(v1, v2))
     }
 
+
+    ## formatting
+    test.Date.formating <- function() {
+        oldTZ <- Sys.getenv("TZ")
+        Sys.setenv(TZ="America/Chicago")
+        d <- as.Date("2011-12-13")
+
+        checkEquals(Date_format(d, "%Y-%m-%d"),
+                    format(d),
+                    msg="Date.formating.default")
+        checkEquals(Date_format(d, "%Y/%m/%d"),
+                    format(d, "%Y/%m/%d"),
+                    msg="Date.formating.given.format")
+
+        Sys.setenv(TZ=oldTZ)
+    }
+
+    test.Datetime.formating <- function() {
+        oldTZ <- Sys.getenv("TZ")
+        Sys.setenv(TZ="America/Chicago")
+
+        olddigits <- getOption("digits.secs")
+        options("digits.secs"=6)
+
+        d <- as.POSIXct("2016-12-13 14:15:16.123456")
+        checkEquals(Datetime_format(d,"%Y-%m-%d %H:%M:%S"),
+                    format(d, "%Y-%m-%d %H:%M:%OS"),
+                    msg="Datetime.formating.default")
+        checkEquals(Datetime_format(d, "%Y/%m/%d %H:%M:%S"),
+                    format(d, "%Y/%m/%d %H:%M:%OS"),
+                    msg="Datetime.formating.given.format")
+
+        Sys.setenv(TZ=oldTZ)
+        options("digits.secs"=olddigits)
+    }
+
+
 }