Merge pull request killercup#29 from killercup/json-stdout

Json stdout and other updates

Author: killercup

.travis.yml

@@ -6,11 +6,11 @@ rust:
 
 matrix:
   include:
-  - rust: 1.29.1
+  - rust: 1.30.1
     env: CLIPPY=YESPLEASE
     before_script: rustup component add clippy-preview
     script: cargo clippy --all-targets --all -- -D warnings
-  - rust: 1.29.1
+  - rust: 1.30.1
     env: RUSTFMT=YESPLEASE
     before_script: rustup component add rustfmt-preview
     script: cargo fmt --all -- --check

Cargo.toml

@@ -27,3 +27,4 @@ assert_fs = "0.9.0"
 predicates = "0.9.0"
 convey_derive = { version = "0.2", path = "convey_derive" }
 rand = "0.5.5"
+structopt = "0.2"

examples/cli.rs

@@ -1,16 +1,31 @@
 extern crate failure;
+extern crate structopt;
+#[macro_use]
+extern crate serde_derive;
 #[macro_use]
 extern crate convey;
 
 use convey::{
     components::{newline, text},
     human, json,
 };
+use structopt::StructOpt;
+
+/// Demo stuff
+#[derive(StructOpt)]
+struct Cli {
+    /// Output JSON instead of human readable messages
+    #[structopt(long = "json")]
+    json: bool,
+}
 
 fn main() -> Result<(), failure::Error> {
-    let mut out = convey::new()
-        .add_target(json::file("target/foo.log")?)
-        .add_target(human::stdout()?);
+    let args = Cli::from_args();
+    let mut out = if args.json {
+        convey::new().add_target(json::stdout()?)
+    } else {
+        convey::new().add_target(human::stdout()?)
+    };
 
     let x = 42;
 
@@ -25,5 +40,30 @@ fn main() -> Result<(), failure::Error> {
         span!(intense = true, ["intense text",]),
     ]))?;
 
+    #[derive(Serialize)]
+    struct ErrorMessage {
+        code: i32,
+        name: String,
+        message: String,
+    }
+
+    impl convey::Render for ErrorMessage {
+        render_for_humans!(self -> [
+            span!(fg = "white", bg = "black", [text(self.code.to_string()), text(" "),]),
+            span!(fg = "red", bg = "black", [text(&self.name),]),
+            newline(),
+            text("> "),
+            text(&self.message),
+        ]);
+
+        render_json!();
+    }
+
+    out.print(&ErrorMessage {
+        code: 42,
+        name: String::from("error"),
+        message: String::from("Oh god no"),
+    })?;
+
     Ok(())
 }

src/components/span.rs

@@ -11,7 +11,7 @@ pub fn span() -> Span {
 macro_rules! __inner_span {
     ($span:ident, $attr:ident = $val:expr, $($token:tt)*) => {
         $span = $span.$attr($val)?;
-        __inner_span!($span, $($token)*);
+        $crate::__inner_span!($span, $($token)*);
     };
     ($span:ident, [$($item:expr,)*]) => {
         $(
@@ -46,7 +46,7 @@ macro_rules! span {
     ($($token:tt)*) => {
         {
             let mut the_span = $crate::components::span();
-            __inner_span!(the_span, $($token)*);
+            $crate::__inner_span!(the_span, $($token)*);
             the_span
         }
     };

src/human.rs

@@ -205,7 +205,7 @@ macro_rules! render_for_humans {
     };
     ($self:ident -> [$($item:expr,)*]) => {
         fn render_for_humans(&$self, fmt: &mut $crate::human::Formatter) -> Result<(), $crate::Error> {
-            let span = span!([ $( $item, )* ]);
+            let span = $crate::span!([ $( $item, )* ]);
             span.render_for_humans(fmt)?;
             Ok(())
         }

src/json.rs

@@ -7,6 +7,14 @@ use std::path::Path;
 use std::sync::Arc;
 use {Error, Target};
 
+/// Construct a new JSON output target that writes to stdout
+pub fn stdout() -> Result<Target, Error> {
+    use std::io::{stdout, BufWriter};
+
+    let formatter = Formatter::init_with(|| Ok(BufWriter::new(stdout())))?;
+    Ok(Target::json(formatter))
+}
+
 /// Create a new JSON output that writes to a file
 pub fn file<T: AsRef<Path>>(name: T) -> Result<Target, Error> {
     let path = name.as_ref().to_path_buf();

src/lib.rs

@@ -14,10 +14,9 @@
 
 #![warn(missing_docs)]
 
+extern crate crossbeam_channel;
 extern crate failure;
-#[macro_use]
 extern crate failure_derive;
-extern crate crossbeam_channel;
 extern crate serde;
 extern crate termcolor;
 #[macro_use]