Cargo.toml: make criterion togglable

Author: remi-dupre

Cargo.toml

@@ -9,9 +9,15 @@ readme = "README.md"
 keywords = ["advent", "aoc", "macro"]
 edition = "2018"
 
+[features]
+# Criterion is a quite heavy dependencies which will not be used in many cases.
+bench = ["criterion"]
+
 [dependencies]
 attohttpc = { version = "0.16.0", default_features = false, features = ["tls"] }
 clap = "3.0.0-beta.2"
 colored = "2.0.0"
-criterion = "0.3.3"
 dirs = "3.0.1"
+
+# Optional dependencies
+criterion = { version = "0.3.3", optional = true }

README.md

@@ -66,6 +66,18 @@ output. Also, the generator can output a structure that contains borrowed data
 from the original input file.
 
 
+Benchmarks
+----------
+
+You can run Criterion benchmarks by running `cargo run --release -- --bench`,
+but first you need to enable the `bench` feature in your *cargo.toml*:
+
+```toml
+[dependencies]
+aoc-main = { version = "*", features = ["bench"] }
+```
+
+
 Fetching your AOC token
 -----------------------
 

src/lib.rs

@@ -7,6 +7,8 @@ use std::path::PathBuf;
 // Reexport some crates for the generated main
 pub use clap;
 pub use colored;
+
+#[cfg(feature = "bench")]
 pub use criterion;
 
 use clap::Clap;
@@ -42,14 +44,13 @@ impl Opt {
 }
 
 #[macro_export]
-macro_rules! main {
+macro_rules! base_main {
     ( year $year: expr; $( $tail: tt )* ) => {
         use std::fs::read_to_string;
         use std::io::Read;
         use std::time::Instant;
 
         use $crate::clap::Clap;
-        use $crate::criterion::*;
         use $crate::{bench_day, extract_day, parse, run_day};
 
         const YEAR: u16 = $year;
@@ -59,45 +60,55 @@ macro_rules! main {
 
             if opt.bench {
                 bench();
-            }
-
-            if opt.days.is_empty() {
-                opt.days = parse!(extract_day {}; $( $tail )*)
-                    .iter()
-                    .map(|s| s[3..].to_string())
-                    .collect();
             } else {
-                let days = parse! { extract_day {}; $( $tail )* };
-
-                let ignored_days: Vec<_> = opt.days
-                    .iter()
-                    .filter(|day| !days.contains(&format!("day{}", day).as_str()))
-                    .map(String::as_str)
-                    .collect();
+                if opt.days.is_empty() {
+                    opt.days = parse!(extract_day {}; $( $tail )*)
+                        .iter()
+                        .map(|s| s[3..].to_string())
+                        .collect();
+                } else {
+                    let days = parse! { extract_day {}; $( $tail )* };
+
+                    let ignored_days: Vec<_> = opt.days
+                        .iter()
+                        .filter(|day| !days.contains(&format!("day{}", day).as_str()))
+                        .map(String::as_str)
+                        .collect();
+
+                    if !ignored_days.is_empty() {
+                        eprintln!(r"/!\ Ignoring unimplemented days: {}", ignored_days.join(", "));
+                    }
+
+                    opt.days = opt.days
+                        .into_iter()
+                        .filter(|day| days.contains(&format!("day{}", day).as_str()))
+                        .collect();
+                }
 
-                if !ignored_days.is_empty() {
-                    eprintln!(r"/!\ Ignoring unimplemented days: {}", ignored_days.join(", "));
+                if opt.days.len() > 1 && (opt.stdin || opt.file.is_some()) {
+                    eprintln!(r"/!\ You are using a personalized output over several days which can");
+                    eprintln!(r"    be missleading. If you only intend to run solutions for a");
+                    eprintln!(r"    specific day, you can specify it by using the `-d DAY_NUM` flag.");
                 }
 
-                opt.days = opt.days
-                    .into_iter()
-                    .filter(|day| days.contains(&format!("day{}", day).as_str()))
-                    .collect();
+                for (i, day) in opt.days.iter().enumerate() {
+                    parse! {
+                        run_day { i, format!("day{}", day), YEAR, opt };
+                        $( $tail )*
+                    };
+                }
             }
+        }
+    }
+}
 
-            if opt.days.len() > 1 && (opt.stdin || opt.file.is_some()) {
-                eprintln!(r"/!\ You are using a personalized output over several days which can");
-                eprintln!(r"    be missleading. If you only intend to run solutions for a");
-                eprintln!(r"    specific day, you can specify it by using the `-d DAY_NUM` flag.");
-            }
+#[cfg(feature = "bench")]
+#[macro_export]
+macro_rules! main {
+    ( year $year: expr; $( $tail: tt )* ) => {
+        $crate::base_main! { year $year; $( $tail )* }
 
-            for (i, day) in opt.days.iter().enumerate() {
-                parse! {
-                    run_day { i, format!("day{}", day), YEAR, opt };
-                    $( $tail )*
-                };
-            }
-        }
+        use $crate::criterion::Criterion;
 
         fn bench() {
             let mut criterion = Criterion::default().configure_from_args();
@@ -109,5 +120,17 @@ macro_rules! main {
 
             criterion.final_summary();
         }
-    };
+    }
+}
+
+#[cfg(not(feature = "bench"))]
+#[macro_export]
+macro_rules! main {
+    ( year $year: expr; $( $tail: tt )* ) => {
+        $crate::base_main! { year $year; $( $tail )* }
+
+        fn bench() {
+            println!("Benchmarks not available, please enable `bench` feature for cargo-main.");
+        }
+    }
 }