src/issues.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 // Objects for seeking through a char stream for occurences of TODO and FIXME.
  12 // Depending on the loaded configuration, may also check that these have an
  13 // associated issue number.
  14
  15 use std::fmt;
  16 pub use config::ReportTactic;
  17
  18 const TO_DO_CHARS: &'static [char] = &['T', 'O', 'D', 'O'];
  19 const FIX_ME_CHARS: &'static [char] = &['F', 'I', 'X', 'M', 'E'];
  20
  21 // Enabled implementation detail is here because it is
  22 // irrelevant outside the issues module
  23 impl ReportTactic {
  24     fn is_enabled(&self) -> bool {
  25         *self != ReportTactic::Never
  26     }
  27 }
  28
  29 #[derive(Clone, Copy)]
  30 enum Seeking {
  31     Issue { todo_idx: usize, fixme_idx: usize },
  32     Number { issue: Issue, part: NumberPart },
  33 }
  34
  35 #[derive(Clone, Copy)]
  36 enum NumberPart {
  37     OpenParen,
  38     Pound,
  39     Number,
  40     CloseParen,
  41 }
  42
  43 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
  44 pub struct Issue {
  45     issue_type: IssueType,
  46     // Indicates whether we're looking for issues with missing numbers, or
  47     // all issues of this type.
  48     missing_number: bool,
  49 }
  50
  51 impl fmt::Display for Issue {
  52     fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
  53         let msg = match self.issue_type {
  54             IssueType::Todo => "TODO",
  55             IssueType::Fixme => "FIXME",
  56         };
  57         let details = if self.missing_number {
  58             " without issue number"
  59         } else {
  60             ""
  61         };
  62
  63         write!(fmt, "{}{}", msg, details)
  64     }
  65 }
  66
  67 #[derive(PartialEq, Eq, Debug, Clone, Copy)]
  68 enum IssueType {
  69     Todo,
  70     Fixme,
  71 }
  72
  73 enum IssueClassification {
  74     Good,
  75     Bad(Issue),
  76     None,
  77 }
  78
  79 pub struct BadIssueSeeker {
  80     state: Seeking,
  81     report_todo: ReportTactic,
  82     report_fixme: ReportTactic,
  83 }
  84
  85 impl BadIssueSeeker {
  86     pub fn new(report_todo: ReportTactic, report_fixme: ReportTactic) -> BadIssueSeeker {
  87         BadIssueSeeker {
  88             state: Seeking::Issue {
  89                 todo_idx: 0,
  90                 fixme_idx: 0,
  91             },
  92             report_todo: report_todo,
  93             report_fixme: report_fixme,
  94         }
  95     }
  96
  97     // Check whether or not the current char is conclusive evidence for an
  98     // unnumbered TO-DO or FIX-ME.
  99     pub fn inspect(&mut self, c: char) -> Option<Issue> {
 100         match self.state {
 101             Seeking::Issue { todo_idx, fixme_idx } => {
 102                 self.state = self.inspect_issue(c, todo_idx, fixme_idx);
 103             }
 104             Seeking::Number { issue, part } => {
 105                 let result = self.inspect_number(c, issue, part);
 106
 107                 if let IssueClassification::None = result {
 108                     return None;
 109                 }
 110
 111                 self.state = Seeking::Issue {
 112                     todo_idx: 0,
 113                     fixme_idx: 0,
 114                 };
 115
 116                 if let IssueClassification::Bad(issue) = result {
 117                     return Some(issue);
 118                 }
 119             }
 120         }
 121
 122         None
 123     }
 124
 125     fn inspect_issue(&mut self, c: char, mut todo_idx: usize, mut fixme_idx: usize) -> Seeking {
 126         // FIXME: Should we also check for lower case characters?
 127         if self.report_todo.is_enabled() && c == TO_DO_CHARS[todo_idx] {
 128             todo_idx += 1;
 129             if todo_idx == TO_DO_CHARS.len() {
 130                 return Seeking::Number {
 131                     issue: Issue {
 132                         issue_type: IssueType::Todo,
 133                         missing_number: if let ReportTactic::Unnumbered = self.report_todo {
 134                             true
 135                         } else {
 136                             false
 137                         },
 138                     },
 139                     part: NumberPart::OpenParen,
 140                 };
 141             }
 142             fixme_idx = 0;
 143         } else if self.report_fixme.is_enabled() && c == FIX_ME_CHARS[fixme_idx] {
 144             // Exploit the fact that the character sets of todo and fixme
 145             // are disjoint by adding else.
 146             fixme_idx += 1;
 147             if fixme_idx == FIX_ME_CHARS.len() {
 148                 return Seeking::Number {
 149                     issue: Issue {
 150                         issue_type: IssueType::Fixme,
 151                         missing_number: if let ReportTactic::Unnumbered = self.report_fixme {
 152                             true
 153                         } else {
 154                             false
 155                         },
 156                     },
 157                     part: NumberPart::OpenParen,
 158                 };
 159             }
 160             todo_idx = 0;
 161         } else {
 162             todo_idx = 0;
 163             fixme_idx = 0;
 164         }
 165
 166         Seeking::Issue {
 167             todo_idx: todo_idx,
 168             fixme_idx: fixme_idx,
 169         }
 170     }
 171
 172     fn inspect_number(&mut self,
 173                       c: char,
 174                       issue: Issue,
 175                       mut part: NumberPart)
 176                       -> IssueClassification {
 177         if !issue.missing_number || c == '\n' {
 178             return IssueClassification::Bad(issue);
 179         } else if c == ')' {
 180             return if let NumberPart::CloseParen = part {
 181                 IssueClassification::Good
 182             } else {
 183                 IssueClassification::Bad(issue)
 184             };
 185         }
 186
 187         match part {
 188             NumberPart::OpenParen => {
 189                 if c != '(' {
 190                     return IssueClassification::Bad(issue);
 191                 } else {
 192                     part = NumberPart::Pound;
 193                 }
 194             }
 195             NumberPart::Pound => {
 196                 if c == '#' {
 197                     part = NumberPart::Number;
 198                 }
 199             }
 200             NumberPart::Number => {
 201                 if c >= '0' && c <= '9' {
 202                     part = NumberPart::CloseParen;
 203                 } else {
 204                     return IssueClassification::Bad(issue);
 205                 }
 206             }
 207             NumberPart::CloseParen => {}
 208         }
 209
 210         self.state = Seeking::Number {
 211             part: part,
 212             issue: issue,
 213         };
 214
 215         IssueClassification::None
 216     }
 217 }
 218
 219 #[test]
 220 fn find_unnumbered_issue() {
 221     fn check_fail(text: &str, failing_pos: usize) {
 222         let mut seeker = BadIssueSeeker::new(ReportTactic::Unnumbered, ReportTactic::Unnumbered);
 223         assert_eq!(Some(failing_pos),
 224                    text.chars().position(|c| seeker.inspect(c).is_some()));
 225     }
 226
 227     fn check_pass(text: &str) {
 228         let mut seeker = BadIssueSeeker::new(ReportTactic::Unnumbered, ReportTactic::Unnumbered);
 229         assert_eq!(None, text.chars().position(|c| seeker.inspect(c).is_some()));
 230     }
 231
 232     check_fail("TODO\n", 4);
 233     check_pass(" TO FIX DOME\n");
 234     check_fail(" \n FIXME\n", 8);
 235     check_fail("FIXME(\n", 6);
 236     check_fail("FIXME(#\n", 7);
 237     check_fail("FIXME(#1\n", 8);
 238     check_fail("FIXME(#)1\n", 7);
 239     check_pass("FIXME(#1222)\n");
 240     check_fail("FIXME(#12\n22)\n", 9);
 241     check_pass("FIXME(@maintainer, #1222, hello)\n");
 242     check_fail("TODO(#22) FIXME\n", 15);
 243 }
 244
 245 #[test]
 246 fn find_issue() {
 247     fn is_bad_issue(text: &str, report_todo: ReportTactic, report_fixme: ReportTactic) -> bool {
 248         let mut seeker = BadIssueSeeker::new(report_todo, report_fixme);
 249         text.chars().any(|c| seeker.inspect(c).is_some())
 250     }
 251
 252     assert!(is_bad_issue("TODO(@maintainer, #1222, hello)\n",
 253                          ReportTactic::Always,
 254                          ReportTactic::Never));
 255
 256     assert!(!is_bad_issue("TODO: no number\n",
 257                           ReportTactic::Never,
 258                           ReportTactic::Always));
 259
 260     assert!(is_bad_issue("This is a FIXME(#1)\n",
 261                          ReportTactic::Never,
 262                          ReportTactic::Always));
 263
 264     assert!(!is_bad_issue("bad FIXME\n", ReportTactic::Always, ReportTactic::Never));
 265 }
 266
 267 #[test]
 268 fn issue_type() {
 269     let mut seeker = BadIssueSeeker::new(ReportTactic::Always, ReportTactic::Never);
 270     let expected = Some(Issue {
 271         issue_type: IssueType::Todo,
 272         missing_number: false,
 273     });
 274
 275     assert_eq!(expected,
 276                "TODO(#100): more awesomeness"
 277                    .chars()
 278                    .map(|c| seeker.inspect(c))
 279                    .find(Option::is_some)
 280                    .unwrap());
 281
 282     let mut seeker = BadIssueSeeker::new(ReportTactic::Never, ReportTactic::Unnumbered);
 283     let expected = Some(Issue {
 284         issue_type: IssueType::Fixme,
 285         missing_number: true,
 286     });
 287
 288     assert_eq!(expected,
 289                "Test. FIXME: bad, bad, not good"
 290                    .chars()
 291                    .map(|c| seeker.inspect(c))
 292                    .find(Option::is_some)
 293                    .unwrap());
 294 }