UDF CaMeL cASe consistency issues

[lintool]

In terms of Scala RDD UDFs, we have:

RemoveHTML(r.getContentString)

And:

RemoveHTML(RemoveHttpHeader(r.getContentString))

I can't think of a case when you'd want clean text but want to keep the HTTP headers... so RemoveHTML should just call RemoveHttpHeader.

Also, we're mixing camel cases, so it should either be:

1. RemoveHtml and RemoveHttpHeader
2. RemoveHTML and RemoveHTTPHeader

Note the MiXEd mess we have now.

Option (1) is more conforming to Java practices, but then we have removePrefixWww, which just looks odd. Maybe we can rename to RemoveW3Prefix?

We also have ComputeMD5 and ComputeSHA1, so perhaps option (2) is better?

Thoughts?

[ruebot]

Oh, there's more (UDFs, class, and object names)!

Might as well make a list so we have more info on whatever decision we make:

• We'll need to sort out all the fooBarDF UDFs in https://github.com/archivesunleashed/aut/blob/master/src/main/scala/io/archivesunleashed/package.scala
• extractPDFDetailsDF
• extractPDFs
• escapeInvalidXML
• NERClassType
• ExtractTextFromPDFs
• WriteGraphXML
• WriteGraphML
• WriteGEXF
• NERCombinedJson

I might have missed some.

---

I can't think of a case when you'd want clean text but want to keep the HTTP headers... so RemoveHTML should just call RemoveHttpHeader.

👍

[lintool]

I think my vote is for RemoveHTML, RemoveHTTPHeader, etc.
Also, fewer things to change.

[ruebot]

I'm confused.

So, if I'm I understanding you correctly, you're suggesting that we don't worry about the list I dropped in, which highlight other examples of what you originally raised, and just roll with inconsistency, or resolve just the two you highlighted?

[lintool]

What I meant was that RemoveHttpHeader seems to be the only UDF that's inconsistently cased. I think if we renamed RemoveHttpHeader to RemoveHTTPHeader, this issue resolves.

[greebie]

FYI - Did some quick research and found Scalastyle does not seem to support custom rule configuration (just on or off), so it might be good to include a short list of style rules in the README (I doubt there are many).

Google style guide wants the former style due to the XMLHTTPRequest readability problem. I don't think we have this problem for aut, and it would be preferable as a rule to put action before format anyway.

[lintool]

Video chat with @ruebot and @ianmilligan1 - conclusion: rename RemoveHttpHeader to RemoveHTTPHeader and all the UDFs will have consistent casing - this will close the issue.