Merge pull request killercup#30 from killercup/log

killercup · web-flow · commit e20994701307 · 2018-12-31T15:11:43.000+01:00
Become a log target
diff --git a/.travis.yml b/.travis.yml
@@ -4,13 +4,17 @@ rust:
 - beta
 - nightly
 
+script:
+- cargo test --all
+- cargo check --no-default-features
+
 matrix:
   include:
-  - rust: 1.30.1
+  - rust: 1.31.1
     env: CLIPPY=YESPLEASE
     before_script: rustup component add clippy-preview
     script: cargo clippy --all-targets --all -- -D warnings
-  - rust: 1.30.1
+  - rust: 1.31.1
     env: RUSTFMT=YESPLEASE
     before_script: rustup component add rustfmt-preview
     script: cargo fmt --all -- --check
diff --git a/Cargo.toml b/Cargo.toml
@@ -6,25 +6,35 @@ description = "A Rust create for outputting information and log messages for hum
 license = "Apache-2.0 OR MIT"
 readme = "README.md"
 repository = "https://github.com/killercup/convey"
+edition = "2018"
 
 [workspace]
 members = [
     "convey_derive"
 ]
 
+[features]
+default = ["log"]
+
+[[example]]
+name = "logging"
+path = "examples/logging.rs"
+required-features = ["log"]
+
 [dependencies]
 termcolor = "1.0.4"
 serde = "1.0.79"
 serde_json = "1.0.31"
 failure_derive = "0.1.2"
 failure = "0.1.2"
 serde_derive = "1.0.79"
-crossbeam-channel = "0.2.6"
+crossbeam-channel = "0.3.4"
+log = { version = "0.4.6", features = ["std", "serde"], optional = true }
 
 [dev-dependencies]
 proptest = "0.8.7"
-assert_fs = "0.9.0"
-predicates = "0.9.0"
+assert_fs = "0.10.0"
+predicates = "1.0.0"
 convey_derive = { version = "0.2", path = "convey_derive" }
-rand = "0.5.5"
+rand = "0.6.1"
 structopt = "0.2"
diff --git a/convey_derive/src/lib.rs b/convey_derive/src/lib.rs
@@ -16,7 +16,7 @@
 //! # fn main() -> Result<(), convey::Error> {
 //! # use convey::human;
 //! # let test_target = human::test();
-//! let mut out = convey::new().add_target(test_target.target());
+//! let out = convey::new().add_target(test_target.target())?;
 //! out.print(&Message {
 //!     code: 42,
 //!     message: String::from("Derive works"),
diff --git a/convey_derive/tests/structs.rs b/convey_derive/tests/structs.rs
@@ -15,9 +15,9 @@ fn struct_with_named_fields_of_primitive_types() -> Result<(), convey::Error> {
 
     let human = convey::human::test();
     let json = convey::json::test();
-    let mut out = convey::new()
-        .add_target(human.target())
-        .add_target(json.target());
+    let out = convey::new()
+        .add_target(human.target())?
+        .add_target(json.target())?;
 
     out.print(&ErrorMessage {
         code: 42,
@@ -48,9 +48,9 @@ fn tuple_struct_of_primitive_types() -> Result<(), convey::Error> {
 
     let human = convey::human::test();
     let json = convey::json::test();
-    let mut out = convey::new()
-        .add_target(human.target())
-        .add_target(json.target());
+    let out = convey::new()
+        .add_target(human.target())?
+        .add_target(json.target())?;
 
     out.print(&ErrorMessage(42, String::from("Derive works")))?;
     out.flush()?;
diff --git a/examples/cli.rs b/examples/cli.rs
@@ -1,5 +1,5 @@
-extern crate failure;
-extern crate structopt;
+use failure;
+use structopt;
 #[macro_use]
 extern crate serde_derive;
 #[macro_use]
@@ -21,10 +21,10 @@ struct Cli {
 
 fn main() -> Result<(), failure::Error> {
     let args = Cli::from_args();
-    let mut out = if args.json {
-        convey::new().add_target(json::stdout()?)
+    let out = if args.json {
+        convey::new().add_target(json::stdout()?)?
     } else {
-        convey::new().add_target(human::stdout()?)
+        convey::new().add_target(human::stdout()?)?
     };
 
     let x = 42;
diff --git a/examples/concurrent.rs b/examples/concurrent.rs
@@ -1,28 +1,21 @@
-extern crate convey;
-extern crate failure;
-extern crate rand;
+use convey;
+use failure;
 
 use convey::{human, json};
-use rand::distributions::Distribution;
-use rand::distributions::Range;
-use rand::thread_rng;
+use rand::{thread_rng, Rng};
 use std::thread;
 use std::time::Duration;
 
 fn main() -> Result<(), failure::Error> {
     let out = convey::new()
-        .add_target(json::file("target/foo.log")?)
-        .add_target(human::stdout()?);
+        .add_target(json::file("target/foo.log")?)?
+        .add_target(human::stdout()?)?;
 
     let mut threads = vec![];
     for i in 0..100 {
-        let mut out = out.clone();
+        let out = out.clone();
         let t = thread::spawn(move || {
-            let dur = Duration::from_millis({
-                let mut rng = thread_rng();
-                let range = Range::new(0u64, 1);
-                range.sample(&mut rng)
-            });
+            let dur = Duration::from_millis(thread_rng().gen_range(0u64, 1));
             thread::sleep(dur);
             out.print(&format!("thread {} says hello", i))
         });
diff --git a/examples/custom.rs b/examples/custom.rs
@@ -1,4 +1,4 @@
-extern crate failure;
+use failure;
 #[macro_use]
 extern crate convey;
 #[macro_use]
@@ -10,9 +10,9 @@ use convey::{
 };
 
 fn main() -> Result<(), failure::Error> {
-    let mut out = convey::new()
-        .add_target(json::file("target/foo.log")?)
-        .add_target(human::stdout()?);
+    let out = convey::new()
+        .add_target(json::file("target/foo.log")?)?
+        .add_target(human::stdout()?)?;
 
     #[derive(Serialize)]
     struct ErrorMessage {
diff --git a/examples/derive.rs b/examples/derive.rs
@@ -1,5 +1,5 @@
-extern crate convey;
-extern crate failure;
+use convey;
+use failure;
 #[macro_use]
 extern crate convey_derive;
 #[macro_use]
@@ -8,9 +8,9 @@ extern crate serde_derive;
 use convey::{human, json};
 
 fn main() -> Result<(), failure::Error> {
-    let mut out = convey::new()
-        .add_target(json::file("target/foo.log")?)
-        .add_target(human::stdout()?);
+    let out = convey::new()
+        .add_target(json::file("target/foo.log")?)?
+        .add_target(human::stdout()?)?;
 
     #[derive(Serialize, RenderOutput)]
     struct ErrorMessage {
diff --git a/examples/logging.rs b/examples/logging.rs
@@ -0,0 +1,11 @@
+fn main() -> Result<(), failure::Error> {
+    let output = convey::new()
+        .add_target(convey::human::stdout()?)?
+        .use_as_logger(log::Level::Debug)?;
+
+    output.print("hello")?;
+    log::info!("welcome");
+    log::error!("oh noes");
+
+    Ok(())
+}
diff --git a/src/components/span.rs b/src/components/span.rs
@@ -1,5 +1,5 @@
+use crate::{human, json, Error, Render};
 use termcolor::ColorSpec;
-use {human, json, Error, Render};
 
 /// Construct a new, empty span
 pub fn span() -> Span {
@@ -31,7 +31,7 @@ macro_rules! __inner_span {
 /// fn main() -> Result<(), convey::Error> {
 ///     use convey::{components::text, human};
 ///
-///     let mut out = convey::new().add_target(human::stdout()?);
+///     let mut out = convey::new().add_target(human::stdout()?)?;
 ///
 ///     let message = span!(fg = "red", [
 ///         text("hello"),
@@ -54,7 +54,7 @@ macro_rules! span {
 
 #[derive(Default)]
 pub struct Span {
-    items: Vec<Box<Render>>,
+    items: Vec<Box<dyn Render>>,
     fg: Option<::termcolor::Color>,
     bg: Option<::termcolor::Color>,
     bold: bool,
@@ -126,8 +126,8 @@ impl Render for Span {
 #[cfg(test)]
 mod test {
     use super::span;
-    use components::text;
-    use {human, json, Error, Render};
+    use crate::components::text;
+    use crate::{human, json, Error, Render};
 
     #[test]
     fn renders_span_children() -> Result<(), Error> {
@@ -149,7 +149,7 @@ mod test {
     #[test]
     fn test_colored_output() -> Result<(), Error> {
         let test_target = human::test_with_color();
-        let mut out = ::new().add_target(test_target.target());
+        let out = crate::new().add_target(test_target.target())?;
 
         out.print(span().add_item("hello").fg("green")?.bg("blue")?)?;
         out.flush()?;
@@ -164,7 +164,7 @@ mod test {
     #[test]
     fn test_bold_output() -> Result<(), Error> {
         let test_target = human::test_with_color();
-        let mut out = ::new().add_target(test_target.target());
+        let out = crate::new().add_target(test_target.target())?;
 
         out.print(span().add_item("hello").bold(true)?)?;
         out.flush()?;
@@ -179,7 +179,7 @@ mod test {
     #[test]
     fn test_intense_output() -> Result<(), Error> {
         let test_target = human::test_with_color();
-        let mut out = ::new().add_target(test_target.target());
+        let out = crate::new().add_target(test_target.target())?;
 
         out.print(span().add_item("hello").fg("green")?.intense(true)?)?;
         out.flush()?;
@@ -194,7 +194,7 @@ mod test {
     #[test]
     fn test_underline_output() -> Result<(), Error> {
         let test_target = human::test_with_color();
-        let mut out = ::new().add_target(test_target.target());
+        let out = crate::new().add_target(test_target.target())?;
 
         out.print(span().add_item("hello").underline(true)?)?;
         out.flush()?;
diff --git a/src/components/text.rs b/src/components/text.rs
@@ -1,4 +1,4 @@
-use {human, json, Error, Render};
+use crate::{human, json, Error, Render};
 
 /// Render some text
 pub fn text<T: AsRef<str>>(input: T) -> Text {
@@ -12,7 +12,7 @@ pub fn newline() -> Text {
     text("\n")
 }
 
-#[derive(Clone, Serialize)]
+#[derive(Clone, serde_derive::Serialize)]
 pub struct Text(String);
 
 impl Render for Text {
@@ -30,7 +30,8 @@ impl Render for Text {
 #[cfg(test)]
 mod test {
     use super::text;
-    use {human, json, Render};
+    use crate::{human, json, Render};
+    use proptest::{prop_assert, prop_assert_eq, proptest, proptest_helper};
 
     proptest! {
         #[test]
@@ -43,7 +44,7 @@ mod test {
 
             let json = json::test();
             item.render_json(&mut json.formatter()).unwrap();
-            prop_assert_eq!(json.to_string(), json!(s).to_string());
+            prop_assert_eq!(json.to_string(), serde_json::json!(s).to_string());
         }
     }
 }
diff --git a/src/error.rs b/src/error.rs
@@ -12,7 +12,7 @@ pub struct Error {
 }
 
 impl Fail for Error {
-    fn cause(&self) -> Option<&Fail> {
+    fn cause(&self) -> Option<&dyn Fail> {
         self.inner.cause()
     }
 
@@ -22,13 +22,16 @@ impl Fail for Error {
 }
 
 impl Display for Error {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         Display::fmt(&self.inner, f)
     }
 }
 
 #[derive(Fail, Debug)]
 enum InnerError {
+    #[fail(display = "{}", _0)]
+    Custom(Context<String>),
+
     #[fail(display = "IO error: {}", _0)]
     Io(io::Error),
 
@@ -43,6 +46,13 @@ enum InnerError {
 
     #[fail(display = "Error syncing output")]
     SyncError(String),
+
+    #[fail(display = "Error sending data to channel")]
+    ChannelError(String),
+
+    #[cfg(feature = "log")]
+    #[fail(display = "{}", _0)]
+    SetLoggerError(log::SetLoggerError),
 }
 
 impl Error {
@@ -59,6 +69,22 @@ impl Error {
     }
 }
 
+impl From<InnerError> for Error {
+    fn from(kind: InnerError) -> Error {
+        Error {
+            inner: Context::new(kind),
+        }
+    }
+}
+
+impl From<Context<String>> for Error {
+    fn from(inner: Context<String>) -> Error {
+        Error {
+            inner: Context::new(InnerError::Custom(inner)),
+        }
+    }
+}
+
 impl From<io::Error> for Error {
     fn from(x: io::Error) -> Self {
         Error {
@@ -82,3 +108,20 @@ impl From<JsonError> for Error {
         }
     }
 }
+
+impl<T: std::fmt::Debug> From<crossbeam_channel::SendError<T>> for Error {
+    fn from(x: crossbeam_channel::SendError<T>) -> Self {
+        Error {
+            inner: Context::new(InnerError::ChannelError(x.to_string())),
+        }
+    }
+}
+
+#[cfg(feature = "log")]
+impl From<log::SetLoggerError> for Error {
+    fn from(x: log::SetLoggerError) -> Self {
+        Error {
+            inner: Context::new(InnerError::SetLoggerError(x)),
+        }
+    }
+}
diff --git a/src/human.rs b/src/human.rs
diff --git a/src/json.rs b/src/json.rs
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/src/logging.rs b/src/logging.rs
