Merge pull request #1982 from Urgau/note_improvements

Improve `@bot note` parsing and some general note improvements

Author: Urgau

parser/src/command/note.rs

@@ -26,28 +26,33 @@ impl NoteCommand {
         let mut toks = input.clone();
         if let Some(Token::Word("note")) = toks.peek_token()? {
             toks.next_token()?;
-            let mut remove = false;
-            loop {
-                match toks.next_token()? {
-                    Some(Token::Word(title)) if title == "remove" => {
-                        remove = true;
-                        continue;
-                    }
-                    Some(Token::Word(title)) | Some(Token::Quote(title)) => {
-                        let command = if remove {
-                            NoteCommand::Remove {
-                                title: title.to_string(),
-                            }
-                        } else {
-                            NoteCommand::Summary {
-                                title: title.to_string(),
-                            }
-                        };
-                        break Ok(Some(command));
-                    }
-                    _ => break Err(toks.error(ParseError::MissingTitle)),
-                };
+
+            let remove = if let Some(Token::Word("remove")) = toks.peek_token()? {
+                toks.next_token()?;
+                true
+            } else {
+                false
+            };
+
+            let title = toks.take_line_until_punc()?.trim();
+
+            // For backwards compatibility we also trim " at the start and end
+            let title = title.trim_matches('"');
+
+            if title.is_empty() {
+                return Err(toks.error(ParseError::MissingTitle));
             }
+
+            let command = if remove {
+                NoteCommand::Remove {
+                    title: title.to_string(),
+                }
+            } else {
+                NoteCommand::Summary {
+                    title: title.to_string(),
+                }
+            };
+            Ok(Some(command))
         } else {
             Ok(None)
         }

parser/src/token.rs

@@ -169,6 +169,14 @@ impl<'a> Tokenizer<'a> {
         self.cur_pos()
     }
 
+    pub fn take_line_until_punc(&mut self) -> Result<&'a str, Error<'a>> {
+        let start = self.cur_pos();
+        while self.cur_punct().is_none() && !self.at_end() {
+            self.advance();
+        }
+        Ok(self.str_from(start))
+    }
+
     pub fn peek_token(&mut self) -> Result<Option<Token<'a>>, Error<'a>> {
         self.clone().next_token()
     }
@@ -349,3 +357,24 @@ fn tokenize_raw_string_prohibit_1() {
         (18, ErrorKind::QuoteInWord)
     );
 }
+
+#[test]
+fn take_line_until_punc() {
+    assert_eq!(
+        Tokenizer::new("this is a text. this another one.").take_line_until_punc(),
+        Ok("this is a text")
+    );
+}
+
+#[test]
+fn take_line_until_punc_2() {
+    assert_eq!(
+        Tokenizer::new("punc is \nnewline").take_line_until_punc(),
+        Ok("punc is ")
+    );
+}
+
+#[test]
+fn take_line_until_punc_3() {
+    assert_eq!(Tokenizer::new("").take_line_until_punc(), Ok(""));
+}

src/handlers/note.rs

@@ -3,7 +3,7 @@
 //! Users can make a new summary entry by commenting the following:
 //!
 //! ```md
-//! @rustbot note summary-title
+//! @rustbot note Summary title
 //! ```
 //!
 //! If this is the first summary entry, rustbot will amend the original post (the top-level comment) to add a "Notes" section. The section should **not** be edited by hand.
@@ -13,7 +13,7 @@
 //!
 //! ### Summary Notes
 //!
-//! - ["summary-title" by @username](link-to-comment)
+//! - [Summary title](link-to-comment) by [username](https://github.com/<username>)
 //!
 //! Generated by triagebot, see [help](https://forge.rust-lang.org/triagebot/note.html) for how to add more
 //! <!-- TRIAGEBOT_SUMMARY_END -->
@@ -26,9 +26,9 @@
 //!
 //! ### Summary Notes
 //!
-//! - ["first-note" by @username](link-to-comment)
-//! - ["second-note" by @username](link-to-comment)
-//! - ["summary-title" by @username](link-to-comment)
+//! - [First note](link-to-comment) by [username](https://github.com/<username>)
+//! - [Second note](link-to-comment) by [username](https://github.com/<username>)
+//! - [Summary title](link-to-comment) by [username](https://github.com/<username>)
 //!
 //! <!-- TRIAGEBOT_SUMMARY_END -->
 //! ```
@@ -50,7 +50,7 @@ struct NoteDataEntry {
 impl NoteDataEntry {
     pub(crate) fn to_markdown(&self) -> String {
         format!(
-            "\n- [\"{title}\" by @{author}]({comment_url})",
+            "\n- [{title}]({comment_url}) by [{author}](https://github.com/{author})",
             title = self.title,
             author = self.author,
             comment_url = self.comment_url
@@ -74,10 +74,10 @@ struct NoteData {
 }
 
 impl NoteData {
-    pub(crate) fn get_url_from_title(&self, title: &str) -> Option<String> {
+    pub(crate) fn get_url_from_title_prefix(&self, title: &str) -> Option<String> {
         let tmp = self.entries_by_url.clone();
         tmp.iter().sorted().find_map(|(key, val)| {
-            if val.title == title {
+            if val.title.starts_with(title) {
                 Some(key.to_owned())
             } else {
                 None
@@ -86,7 +86,7 @@ impl NoteData {
     }
 
     pub(crate) fn remove_by_title(&mut self, title: &str) -> Option<NoteDataEntry> {
-        if let Some(url_to_remove) = self.get_url_from_title(title) {
+        if let Some(url_to_remove) = self.get_url_from_title_prefix(title) {
             if let Some(entry) = self.entries_by_url.remove(&url_to_remove) {
                 log::debug!("SUCCESSFULLY REMOVED ENTRY: {:#?}", &entry);
                 Some(entry)