Add default features for time and compression

.github/workflows/rust.yml

@@ -26,5 +26,11 @@ jobs:
           - os: windows-latest  
     steps:
     - uses: actions/checkout@v3
-    - name: Test
+    - name: Test (default features)
       run: cargo test
+    - name: Test (no default features)
+      run: cargo test --tests --no-default-features
+    - name: Test (compression feature only)
+      run: cargo test --tests --no-default-features --features compression
+    - name: Test (time feature only)
+      run: cargo test --tests --no-default-features --features time

Cargo.toml

@@ -9,9 +9,14 @@ repository = "https://github.com/kstrafe/file-rotate"
 keywords= ["log", "rotate", "logrotate"]
 license = "MIT"
 
+[features]
+default = ["time", "compression"]
+time = ["dep:chrono"]
+compression = ["dep:flate2"]
+
 [dependencies]
-chrono = { version = "0.4.20", default-features = false, features = ["clock"] }
-flate2 = "1.0"
+chrono = { version = "0.4.20", default-features = false, features = ["clock"], optional = true }
+flate2 = { version = "1.0", optional = true }
 
 [dev-dependencies]
 filetime = "0.2"

src/lib.rs

@@ -291,7 +291,9 @@
     unused_qualifications
 )]
 
+#[cfg(feature = "time")]
 use chrono::prelude::*;
+#[cfg(feature = "compression")]
 use compression::*;
 use std::io::{BufRead, BufReader};
 use std::{
@@ -306,6 +308,7 @@ use suffix::*;
 #[cfg(unix)]
 use std::os::unix::fs::OpenOptionsExt;
 
+#[cfg(feature = "compression")]
 pub mod compression;
 pub mod suffix;
 #[cfg(test)]
@@ -315,6 +318,7 @@ mod tests;
 
 /// At which frequency to rotate the file.
 #[derive(Clone, Copy, Debug)]
+#[cfg(feature = "time")]
 pub enum TimeFrequency {
     /// Rotate every hour.
     Hourly,
@@ -336,6 +340,7 @@ pub enum ContentLimit {
     /// Cut the log file at line breaks.
     Lines(usize),
     /// Cut the log at time interval.
+    #[cfg(feature = "time")]
     Time(TimeFrequency),
     /// Cut the log file after surpassing size in bytes (but having written a complete buffer from a write call.)
     BytesSurpassed(usize),
@@ -385,15 +390,14 @@ impl<Repr: Representation> PartialOrd for SuffixInfo<Repr> {
 pub struct FileRotate<S: SuffixScheme> {
     basepath: PathBuf,
     file: Option<File>,
-    modified: Option<DateTime<Local>>,
+    #[cfg(feature = "time")] modified: Option<DateTime<Local>>,
     content_limit: ContentLimit,
     count: usize,
-    compression: Compression,
+    #[cfg(feature = "compression")] compression: Compression,
     suffix_scheme: S,
     /// The bool is whether or not there's a .gz suffix to the filename
     suffixes: BTreeSet<SuffixInfo<S::Repr>>,
-    #[cfg(unix)]
-    mode: Option<u32>,
+    #[cfg(unix)] mode: Option<u32>,
 }
 
 impl<S: SuffixScheme> FileRotate<S> {
@@ -411,7 +415,7 @@ impl<S: SuffixScheme> FileRotate<S> {
         path: P,
         suffix_scheme: S,
         content_limit: ContentLimit,
-        compression: Compression,
+        #[cfg(feature = "compression")] compression: Compression,
         #[cfg(unix)] mode: Option<u32>,
     ) -> Self {
         match content_limit {
@@ -421,7 +425,7 @@ impl<S: SuffixScheme> FileRotate<S> {
             ContentLimit::Lines(lines) => {
                 assert!(lines > 0);
             }
-            ContentLimit::Time(_) => {}
+            #[cfg(feature = "time")] ContentLimit::Time(_) => {}
             ContentLimit::BytesSurpassed(bytes) => {
                 assert!(bytes > 0);
             }
@@ -433,15 +437,14 @@ impl<S: SuffixScheme> FileRotate<S> {
 
         let mut s = Self {
             file: None,
-            modified: None,
+            #[cfg(feature = "time")] modified: None,
             basepath,
             content_limit,
             count: 0,
-            compression,
+            #[cfg(feature = "compression")] compression,
             suffixes: BTreeSet::new(),
             suffix_scheme,
-            #[cfg(unix)]
-            mode,
+            #[cfg(unix)] mode,
         };
         s.ensure_log_directory_exists();
         s.scan_suffixes();
@@ -473,6 +476,7 @@ impl<S: SuffixScheme> FileRotate<S> {
                         ContentLimit::Lines(_) => {
                             self.count = BufReader::new(file).lines().count();
                         }
+                        #[cfg(feature = "time")]
                         ContentLimit::Time(_) => {
                             self.modified = mtime(file);
                         }
@@ -607,6 +611,7 @@ impl<S: SuffixScheme> FileRotate<S> {
         }
 
         // Compression
+        #[cfg(feature = "compression")]
         if let Compression::OnRotate(max_file_n) = self.compression {
             let n = (self.suffixes.len() as i32 - max_file_n as i32).max(0) as usize;
             // The oldest N files should be compressed
@@ -652,6 +657,7 @@ impl<S: SuffixScheme> Write for FileRotate<S> {
                     file.write_all(buf)?;
                 }
             }
+            #[cfg(feature = "time")]
             ContentLimit::Time(time) => {
                 let local: DateTime<Local> = now();
 
@@ -741,7 +747,7 @@ impl<S: SuffixScheme> Write for FileRotate<S> {
 }
 
 /// Get modification time, in non test case.
-#[cfg(not(test))]
+#[cfg(all(not(test), feature = "time"))]
 fn mtime(file: &File) -> Option<DateTime<Local>> {
     if let Ok(time) = file.metadata().and_then(|metadata| metadata.modified()) {
         return Some(time.into());
@@ -751,19 +757,19 @@ fn mtime(file: &File) -> Option<DateTime<Local>> {
 }
 
 /// Get modification time, in test case.
-#[cfg(test)]
+#[cfg(all(test, feature = "time"))]
 fn mtime(_: &File) -> Option<DateTime<Local>> {
     Some(now())
 }
 
 /// Get system time, in non test case.
-#[cfg(not(test))]
+#[cfg(all(not(test), feature = "time"))]
 fn now() -> DateTime<Local> {
     Local::now()
 }
 
 /// Get mocked system time, in test case.
-#[cfg(test)]
+#[cfg(all(test, feature = "time"))]
 pub mod mock_time {
     use super::*;
     use std::cell::RefCell;
@@ -781,5 +787,5 @@ pub mod mock_time {
     }
 }
 
-#[cfg(test)]
+#[cfg(all(test, feature = "time"))]
 pub use mock_time::now;

src/suffix.rs

@@ -3,11 +3,14 @@
 //! This behaviour is fully extensible through the [SuffixScheme] trait, and two behaviours are
 //! provided: [AppendCount] and [AppendTimestamp]
 //!
+#[cfg(feature = "time")]
 use super::now;
 use crate::SuffixInfo;
+#[cfg(feature = "time")]
 use chrono::{format::ParseErrorKind, offset::Local, Duration, NaiveDateTime};
+#[cfg(feature = "time")]
+use std::cmp::Ordering;
 use std::{
-    cmp::Ordering,
     collections::BTreeSet,
     io,
     path::{Path, PathBuf},
@@ -141,6 +144,7 @@ impl SuffixScheme for AppendCount {
 }
 
 /// Add timestamp from:
+#[cfg(feature = "time")]
 pub enum DateFrom {
     /// Date yesterday, to represent the timestamps within the log file.
     DateYesterday,
@@ -156,6 +160,7 @@ pub enum DateFrom {
 /// Current limitations:
 ///  - Neither `format` nor the base filename can include the character `"."`.
 ///  - The `format` should ensure that the lexical and chronological orderings are the same
+#[cfg(feature = "time")]
 pub struct AppendTimestamp {
     /// The format of the timestamp suffix
     pub format: &'static str,
@@ -165,6 +170,7 @@ pub struct AppendTimestamp {
     pub date_from: DateFrom,
 }
 
+#[cfg(feature = "time")]
 impl AppendTimestamp {
     /// With format `"%Y%m%dT%H%M%S"`
     pub fn default(file_limit: FileLimit) -> Self {
@@ -186,13 +192,16 @@ impl AppendTimestamp {
 
 /// Structured representation of the suffixes of AppendTimestamp.
 #[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg(feature = "time")]
 pub struct TimestampSuffix {
     /// The timestamp
     pub timestamp: String,
     /// Optional number suffix if two timestamp suffixes are the same
     pub number: Option<usize>,
 }
+#[cfg(feature = "time")]
 impl Representation for TimestampSuffix {}
+#[cfg(feature = "time")]
 impl Ord for TimestampSuffix {
     fn cmp(&self, other: &Self) -> Ordering {
         // Most recent = smallest (opposite as the timestamp Ord)
@@ -203,11 +212,13 @@ impl Ord for TimestampSuffix {
         }
     }
 }
+#[cfg(feature = "time")]
 impl PartialOrd for TimestampSuffix {
     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
         Some(self.cmp(other))
     }
 }
+#[cfg(feature = "time")]
 impl std::fmt::Display for TimestampSuffix {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
         match self.number {
@@ -217,6 +228,7 @@ impl std::fmt::Display for TimestampSuffix {
     }
 }
 
+#[cfg(feature = "time")]
 impl SuffixScheme for AppendTimestamp {
     type Repr = TimestampSuffix;
 
@@ -304,12 +316,13 @@ pub enum FileLimit {
     /// Delete the oldest files if number of files is too high
     MaxFiles(usize),
     /// Delete files whose age exceeds the `Duration` - age is determined by the suffix of the file
+    #[cfg(feature = "time")]
     Age(Duration),
     /// Never delete files
     Unlimited,
 }
 
-#[cfg(test)]
+#[cfg(all(test, feature = "time"))]
 mod test {
     use super::*;
     use std::fs::File;