New plugin: tangorin #3

winterthediplomat · 2016-10-07T21:25:39Z

This is a (possible) implementation for the tangorin plugin that is already present in Descartes but not in Gauss.

I didn't write lots of Rust until now, so if you spot something that is not idiomatic, or could be done better, or just mistakes I overlooked, I'll be more than happy to fix them.

Fixes #2

… function

…_text

RoxasShadow · 2016-10-08T22:02:04Z

src/plugins/tangorin.rs

+impl Tangorin {
+    fn grep_kanji(&self, msg: &str) -> Option<String> {
+        match RE.captures(msg) {
+            Some(captures) => {


Some(captures) => captures.at(1).map(|e| e.to_owned())

RoxasShadow · 2016-10-08T22:02:49Z

src/plugins/tangorin.rs

+
+    fn retrieve_from_selector(&self, doc: &kuchiki::NodeRef, selector: &str) -> Option<String> {
+        if let Some(match_) = doc.select(selector).unwrap().next() {
+            let node    = match_.as_node().first_child().unwrap();


check the indentation here, it looks quite weird

ssh on spotty connections is suffering and makes me miss this kind of errors. fixed.

RoxasShadow · 2016-10-08T22:03:17Z

src/plugins/tangorin.rs

+        if let Some(match_) = doc.select(selector).unwrap().next() {
+            let node    = match_.as_node().first_child().unwrap();
+            let borrowed_text   = node.as_text().unwrap().borrow();
+            let mut retrieved_text = borrowed_text.clone();


I think this doesn't need to be mutable as you should be able to do everything in a single line, right?

now this not mutable anymore. Originally, I had some problems with borrowed_text lifetimes: to fix it I put each change to its own line, but didn't recompose things back.

RoxasShadow · 2016-10-08T22:06:15Z

src/plugins/tangorin.rs

+
+            Some(retrieved_text)
+        }
+        else{


I don't like much this line. What about an early return on the very top of the function?

refactored the whole thing, so early returns are not necessary anymore.

RoxasShadow · 2016-10-08T22:06:42Z

src/plugins/tangorin.rs

+        if let Some(match_) = doc.select("span[class=eng]").unwrap().next() {
+            let node = match_.as_node(); 
+            let children = node.children();
+            let mut meaning = "".to_string();


String::new() in place of "".to_string()

RoxasShadow · 2016-10-08T22:18:29Z

src/plugins/tangorin.rs

+        };
+
+        if let Ok(doc) = kuchiki::parse_html().from_http(&url) {
+            let romaji = match self.retrieve_from_selector(&doc, "rt"){


What if we make a macro to reduce this redundant lines?

implemented a simple macro called get_text!. it definitely cuts the noise down.

RoxasShadow · 2016-10-08T22:18:51Z

src/plugins/tangorin.rs

+            let info : String = match self.retrieve_info(&doc) {
+                Some(retrieved) => {
+                    let sanitized = retrieved.replace("\u{2014}", "").replace(".", "").to_lowercase();
+                    (" (".to_string()+sanitized.as_str()+")").to_string()


i felt there was a better way to do that, but didn't look at the docs. fixed.

RoxasShadow · 2016-10-08T22:19:03Z

src/plugins/tangorin.rs

+                    let sanitized = retrieved.replace("\u{2014}", "").replace(".", "").to_lowercase();
+                    (" (".to_string()+sanitized.as_str()+")").to_string()
+                },
+                None => "".to_string()


String::new

RoxasShadow · 2016-10-08T22:20:10Z

src/plugins/tangorin.rs

+                None => "".to_string()
+            };
+
+            return server.send_privmsg(target, &format!("[Tangorin] {} ({} - {}): {}{}", &*kanji, &*kana, &*romaji, &*meaning, &*info))


I'm pretty sure that filling a proper struct with these data and using the ToString trait would work great

I don't really think so. Creating an useless struct just to use .to_string is not as readable as a format!, especially considering that the retrieved information is not shared with other plugins or stored in any way.

At least let's try to format that string properly (splitting the vars in multiple lines just work fine) as right now that's. struct as very lightweight btw :)

RoxasShadow · 2016-10-08T22:20:34Z

src/plugins/tangorin.rs

+        assert_eq!("PRIVMSG test :[Tangorin] 頑な (かたくな - katakuna): obstinate (usually written using kana alone)\r\n",
+                   &*get_server_value(&server));
+    }
+


useless line here, one is enough

should be fixed

in `retrieve_*` function, use matches instead of `if let ... else` to make code smaller and more readable

RoxasShadow · 2016-10-09T19:36:01Z

src/plugins/tangorin.rs

+            Some(match_) => {
+                let node = match_.as_node().first_child().unwrap();
+                let borrowed_text = node.as_text().unwrap().borrow();
+                Some(borrowed_text.clone().trim().to_string())


to_owned() is better than clone() as it is an its specialisation

RoxasShadow · 2016-10-09T19:36:47Z

src/plugins/tangorin.rs

+    static ref RE: Regex = Regex::new(r"!tangorin (\S+)").unwrap();
+}
+
+macro_rules! get_text {


try_option to be more similar to try?

RoxasShadow · 2016-10-09T19:37:51Z

src/plugins/tangorin.rs

+
+    fn retrieve_meaning(&self, doc: &kuchiki::NodeRef) -> Option<String> {
+        match doc.select("span[class=eng]").unwrap().next() {
+            None => None,


Can you think a way to avoid this None => None in many places? like an early return or so

as discussed privately, I've switched to Options.map when the conversion is easy and meaningful.

RoxasShadow · 2016-10-09T19:38:07Z

src/plugins/tangorin.rs

+                    if let Some(text) = child.as_text() {
+                        meaning.push_str(text.borrow().as_str());
+                    }
+                    else{


put a space after else please

RoxasShadow · 2016-10-09T19:38:32Z

src/plugins/tangorin.rs

+                let following_siblings = node.following_siblings();
+
+                match following_siblings.select("i[class=d-info]") {
+                    Err(()) => None,


RoxasShadow · 2016-10-09T19:39:00Z

src/plugins/tangorin.rs

+
+                match following_siblings.select("i[class=d-info]") {
+                    Err(()) => None,
+                    Ok(mut info_sibs) => {


you can avoid {...} as using direct => match is enough

RoxasShadow · 2016-10-09T19:41:11Z

src/plugins/tangorin.rs

+                match following_siblings.select("i[class=d-info]") {
+                    Err(()) => None,
+                    Ok(mut info_sibs) => {
+                        match info_sibs.next() {


info_sibs.next().map(|n| ...)

RoxasShadow · 2016-10-09T19:41:33Z

src/plugins/tangorin.rs

+        match root.first_child(){
+            None => None,
+            Some(match_) => {
+                match match_.as_text() {


match_.as_text().map(|n| ...)

RoxasShadow · 2016-10-12T08:43:17Z

src/plugins/tangorin.rs

-        match doc.select(selector).unwrap().next() {
-            Some(match_) => {
+        doc.select(selector).unwrap().next().map(|match_| {
                let node = match_.as_node().first_child().unwrap();


there's an indentation problem here maybe?

RoxasShadow · 2016-10-12T08:43:31Z

src/plugins/tangorin.rs

+                if let Some(text) = child.as_text() {
+                    meaning.push_str(text.borrow().as_str());
+                }
+                else {


RoxasShadow · 2016-10-12T08:44:26Z

src/plugins/tangorin.rs

+
+    fn retrieve_from_selector(&self, doc: &kuchiki::NodeRef, selector: &str) -> Option<String> {
+        doc.select(selector).unwrap().next().map(|match_| {
+                let node = match_.as_node().first_child().unwrap();


indentation problem here

forgot to fix it in the previous patch :V

RoxasShadow · 2016-10-12T08:44:57Z

src/plugins/tangorin.rs

+    }
+
+    fn inner_text(&self, root: &kuchiki::NodeRef) -> Option<String> {
+        match root.first_child(){


put a space before the {

RoxasShadow · 2016-10-12T08:45:29Z

src/plugins/tangorin.rs

+            let kana = try_option!(self.retrieve_from_selector(&doc, "rb"));
+            let kanji = try_option!(self.retrieve_from_selector(&doc, "span[class=writing]"));
+            let meaning = try_option!(self.retrieve_meaning(&doc));
+            let info : String = match self.retrieve_info(&doc) {


don't put any space before the : (i.e. let info: String =)

RoxasShadow · 2016-10-12T08:47:19Z

src/plugins/tangorin.rs

+            let kanji = try_option!(self.retrieve_from_selector(&doc, "span[class=writing]"));
+            let meaning = try_option!(self.retrieve_meaning(&doc));
+            let info : String = match self.retrieve_info(&doc) {
+                Some(retrieved) => format!(" ({})", retrieved.replace("\u{2014}", "").replace(".", "").to_lowercase()),


WDYT about String::remove here?

unfortunately String::remove does not do what we thought it does:
Removes a char from this String at a byte position and returns it..
String::replace is still the only method to do that.

RoxasShadow · 2016-10-12T08:48:06Z

This is cool, just a couple of request changes and we can merge this – thanks a lot 👍

winterthediplomat added 6 commits October 7, 2016 23:10

plugins/tangorin: implement romaji and kana retrieval

c780f8c

plugins/tangorin: retrieve the first kanji in the list in a different…

303a0b4

… function

plugins/tangorin: add meaning in the generated reply, fix test names

c0eeb5a

plugins/tangorin: implement the 'info' retrieval

d4ed6c1

plugins/tangorin: remove duplicated code, rename deeper_text to inner…

aaaf1be

…_text

plugins/tangorin: simplify capturing, rename capturing method

ccb057f

RoxasShadow requested changes Oct 8, 2016

View reviewed changes

winterthediplomat added 3 commits October 9, 2016 19:32

plugins/tangorin: fix typos and suggestions

b078214

plugins/tangorin: replace redundant code with get_text! macro

423502c

plugins/tangorin: refactor text retrieval code

90751fa

in `retrieve_*` function, use matches instead of `if let ... else` to make code smaller and more readable

RoxasShadow requested changes Oct 9, 2016

View reviewed changes

plugins/tangorin: implement second batch of fixes

88f84fc

RoxasShadow requested changes Oct 12, 2016

View reviewed changes

plugins/tangorin: fix indentation and typos

43dfe83

RoxasShadow merged commit 363645f into RoxasShadow:master Oct 12, 2016

New plugin: tangorin #3

New plugin: tangorin #3

Uh oh!

Conversation

winterthediplomat commented Oct 7, 2016

Uh oh!

RoxasShadow Oct 8, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RoxasShadow Oct 8, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RoxasShadow Oct 9, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RoxasShadow Oct 9, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RoxasShadow Oct 9, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RoxasShadow Oct 8, 2016 •

edited

Loading

RoxasShadow Oct 8, 2016 •

edited

Loading

RoxasShadow Oct 9, 2016 •

edited

Loading

RoxasShadow Oct 9, 2016 •

edited

Loading

RoxasShadow Oct 9, 2016 •

edited

Loading