[jira] [Resolved] (ROL-1229) Rename RefererManager to ReferrerManager

["Glen Mazza (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/ROL-1229?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Glen Mazza resolved ROL-1229.
-----------------------------

    Resolution: Not A Problem

(paraphrased from a Roller Dev email I just sent): The proposed change would be extensive -- it's not just that four classes would need renaming (including TurnoverReferersTask, JPARefererManagerImpl, and RefererTest), there's "referer" member variables and accessor methods within those classes that would need updating, affecting roughly 25 other classes that call any of those four classes' methods.  Possibly more in the ORM files, as the database table is called "Referer" which presumably, in order to be consistent, we should rename as well, bringing up backward compatibility headaches during Roller upgrades.

I'm also not fully persuaded of the validity of the change (even if it were simple to do) as "Referer" can be considered a proper noun given that it's defined as such in the HTTP specification (http://en.wikipedia.org/wiki/HTTP_referer) and therefore can't be a misspelling.  (It is often used according to the Wikipedia article today with that spelling and helps clarify that we're referring to HTTP referers specifically and not referrers in general.) If the HTTP specification called a referrer a "pumpkin" then we'd have an "PumpkinManager", "pumpkn" then a "PumpknManager", "xxxxx" then an "XxxxxManager", etc., none of which would be misspellings.  So we have "RefererManager" today.  Maybe if starting from scratch today we would have called it Referrer, but the decision made back then is reasonable enough to continue with.

                
> Rename RefererManager to ReferrerManager
> ----------------------------------------
>
>                 Key: ROL-1229
>                 URL: https://issues.apache.org/jira/browse/ROL-1229
>             Project: Roller
>          Issue Type: Improvement
>    Affects Versions: 3.0
>            Reporter: Craig L Russell
>            Assignee: Glen Mazza
>            Priority: Minor
>
> Craig L Russell wrote:
> I noticed (again with 3.0) that the ReferrerManager interface name is misspelled. According to my IDE, there are 35 occurrences of this interface name in the entire source code.
> It seems that 3.0 might be the right time to fix this.
> If everyone agrees, I can provide a patch. I don't think I should check it in, because I'm not comfortable enough with making sure that I didn't cause a regression because of a missed update.
> Craig
> Allen responded:
> I agree that we should rename it, but I think it's too late to do this for 3.0.  We've already spent way too much time testing/refining the release to go in and do a sweeping change that touches lots of classes.
> Also, I don't think there is any reason that change can't be made for the next release.  I would actually prefer that we do a single rename for all of our classes rather than keep picking at them one at a time. For example I would be a strong supporter of a few other renamings ...
> 1. Website -> Weblog
> 2. Remove "Data" from the names of all the pojos.
> 3. Referer -> Referrer
> 4. Index -> Search
> and probably a few others if I looked harder.  so rather than try to squeeze this in for 3.0, why don't we plan to make it a feature for 3.1 and do a more complete renaming.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira