]> git.lizzy.rs Git - rust.git/blobdiff - src/rustfmt_diff.rs
Merge pull request #2352 from topecongiro/issue-2337
[rust.git] / src / rustfmt_diff.rs
index d6b021d42d4ee06e6acf698db59c71c19f90de04..d563e6eee3c17b44438dca410c8002dedcd9c67a 100644 (file)
@@ -8,11 +8,12 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+use config::Color;
 use diff;
 use std::collections::VecDeque;
 use std::io;
 use term;
-use utils::isatty;
+use utils::use_colored_tty;
 
 #[derive(Debug, PartialEq)]
 pub enum DiffLine {
@@ -36,6 +37,43 @@ fn new(line_number: u32) -> Mismatch {
     }
 }
 
+// This struct handles writing output to stdout and abstracts away the logic
+// of printing in color, if it's possible in the executing environment.
+pub struct OutputWriter {
+    terminal: Option<Box<term::Terminal<Output = io::Stdout>>>,
+}
+
+impl OutputWriter {
+    // Create a new OutputWriter instance based on the caller's preference
+    // for colorized output and the capabilities of the terminal.
+    pub fn new(color: Color) -> Self {
+        if let Some(t) = term::stdout() {
+            if use_colored_tty(color) && t.supports_color() {
+                return OutputWriter { terminal: Some(t) };
+            }
+        }
+        OutputWriter { terminal: None }
+    }
+
+    // Write output in the optionally specified color. The output is written
+    // in the specified color if this OutputWriter instance contains a
+    // Terminal in its `terminal` field.
+    pub fn writeln(&mut self, msg: &str, color: Option<term::color::Color>) {
+        match &mut self.terminal {
+            Some(ref mut t) => {
+                if let Some(color) = color {
+                    t.fg(color).unwrap();
+                }
+                writeln!(t, "{}", msg).unwrap();
+                if color.is_some() {
+                    t.reset().unwrap();
+                }
+            }
+            None => println!("{}", msg),
+        }
+    }
+}
+
 // Produces a diff between the expected output and actual output of rustfmt.
 pub fn make_diff(expected: &str, actual: &str, context_size: usize) -> Vec<Mismatch> {
     let mut line_number = 1;
@@ -96,67 +134,24 @@ pub fn make_diff(expected: &str, actual: &str, context_size: usize) -> Vec<Misma
     results
 }
 
-pub fn print_diff<F>(diff: Vec<Mismatch>, get_section_title: F)
+pub fn print_diff<F>(diff: Vec<Mismatch>, get_section_title: F, color: Color)
 where
     F: Fn(u32) -> String,
 {
-    match term::stdout() {
-        Some(ref t) if isatty() && t.supports_color() => {
-            print_diff_fancy(diff, get_section_title, term::stdout().unwrap())
-        }
-        _ => print_diff_basic(diff, get_section_title),
-    }
-}
-
-fn print_diff_fancy<F>(
-    diff: Vec<Mismatch>,
-    get_section_title: F,
-    mut t: Box<term::Terminal<Output = io::Stdout>>,
-) where
-    F: Fn(u32) -> String,
-{
-    for mismatch in diff {
-        let title = get_section_title(mismatch.line_number);
-        writeln!(t, "{}", title).unwrap();
+    let mut writer = OutputWriter::new(color);
 
-        for line in mismatch.lines {
-            match line {
-                DiffLine::Context(ref str) => {
-                    t.reset().unwrap();
-                    writeln!(t, " {}⏎", str).unwrap();
-                }
-                DiffLine::Expected(ref str) => {
-                    t.fg(term::color::GREEN).unwrap();
-                    writeln!(t, "+{}⏎", str).unwrap();
-                }
-                DiffLine::Resulting(ref str) => {
-                    t.fg(term::color::RED).unwrap();
-                    writeln!(t, "-{}⏎", str).unwrap();
-                }
-            }
-        }
-        t.reset().unwrap();
-    }
-}
-
-pub fn print_diff_basic<F>(diff: Vec<Mismatch>, get_section_title: F)
-where
-    F: Fn(u32) -> String,
-{
     for mismatch in diff {
         let title = get_section_title(mismatch.line_number);
-        println!("{}", title);
+        writer.writeln(&format!("{}", title), None);
 
         for line in mismatch.lines {
             match line {
-                DiffLine::Context(ref str) => {
-                    println!(" {}⏎", str);
-                }
+                DiffLine::Context(ref str) => writer.writeln(&format!(" {}⏎", str), None),
                 DiffLine::Expected(ref str) => {
-                    println!("+{}⏎", str);
+                    writer.writeln(&format!("+{}⏎", str), Some(term::color::GREEN))
                 }
                 DiffLine::Resulting(ref str) => {
-                    println!("-{}⏎", str);
+                    writer.writeln(&format!("-{}⏎", str), Some(term::color::RED))
                 }
             }
         }
@@ -165,52 +160,88 @@ pub fn print_diff_basic<F>(diff: Vec<Mismatch>, get_section_title: F)
 
 #[cfg(test)]
 mod test {
-    use super::{make_diff,Mismatch};
+    use super::{make_diff, Mismatch};
     use super::DiffLine::*;
 
     #[test]
     fn diff_simple() {
         let src = "one\ntwo\nthree\nfour\nfive\n";
-        let dest= "one\ntwo\ntrois\nfour\nfive\n";
+        let dest = "one\ntwo\ntrois\nfour\nfive\n";
         let diff = make_diff(src, dest, 1);
-        assert_eq!(diff, vec![Mismatch { line_number: 2,
-                                         lines: vec![
-                                             Context("two".into()),
-                                             Resulting("three".into()),
-                                             Expected("trois".into()),
-                                             Context("four".into()),
-                                         ] }]);
+        assert_eq!(
+            diff,
+            vec![
+                Mismatch {
+                    line_number: 2,
+                    lines: vec![
+                        Context("two".to_owned()),
+                        Resulting("three".to_owned()),
+                        Expected("trois".to_owned()),
+                        Context("four".to_owned()),
+                    ],
+                },
+            ]
+        );
     }
 
     #[test]
     fn diff_simple2() {
         let src = "one\ntwo\nthree\nfour\nfive\nsix\nseven\n";
-        let dest= "one\ntwo\ntrois\nfour\ncinq\nsix\nseven\n";
+        let dest = "one\ntwo\ntrois\nfour\ncinq\nsix\nseven\n";
         let diff = make_diff(src, dest, 1);
-        assert_eq!(diff, vec![Mismatch { line_number: 2,
-                                         lines: vec![
-                                             Context("two".into()),
-                                             Resulting("three".into()),
-                                             Expected("trois".into()),
-                                             Context("four".into()),
-                                         ] },
-                              Mismatch { line_number: 5,
-                                         lines: vec![
-                                             Resulting("five".into()),
-                                             Expected("cinq".into()),
-                                             Context("six".into()),
-                                         ] }]);
+        assert_eq!(
+            diff,
+            vec![
+                Mismatch {
+                    line_number: 2,
+                    lines: vec![
+                        Context("two".to_owned()),
+                        Resulting("three".to_owned()),
+                        Expected("trois".to_owned()),
+                        Context("four".to_owned()),
+                    ],
+                },
+                Mismatch {
+                    line_number: 5,
+                    lines: vec![
+                        Resulting("five".to_owned()),
+                        Expected("cinq".to_owned()),
+                        Context("six".to_owned()),
+                    ],
+                },
+            ]
+        );
     }
 
     #[test]
     fn diff_zerocontext() {
         let src = "one\ntwo\nthree\nfour\nfive\n";
-        let dest= "one\ntwo\ntrois\nfour\nfive\n";
+        let dest = "one\ntwo\ntrois\nfour\nfive\n";
         let diff = make_diff(src, dest, 0);
-        assert_eq!(diff, vec![Mismatch { line_number: 3,
-                                         lines: vec![
-                                             Resulting("three".into()),
-                                             Expected("trois".into()),
-                                         ] }]);
+        assert_eq!(
+            diff,
+            vec![
+                Mismatch {
+                    line_number: 3,
+                    lines: vec![Resulting("three".to_owned()), Expected("trois".to_owned())],
+                },
+            ]
+        );
     }
-}
\ No newline at end of file
+
+    #[test]
+    fn diff_trailing_newline() {
+        let src = "one\ntwo\nthree\nfour\nfive";
+        let dest = "one\ntwo\nthree\nfour\nfive\n";
+        let diff = make_diff(src, dest, 1);
+        assert_eq!(
+            diff,
+            vec![
+                Mismatch {
+                    line_number: 5,
+                    lines: vec![Context("five".to_owned()), Expected("".to_owned())],
+                },
+            ]
+        );
+    }
+}