Word of warning to developers
-
Dear Rick, all,
@rickw said:
Interesting concept, and for creating Module names, it could work. However, locating files in subfolders by organization/author name conflicts with Organizer.rb.
sorry, I wasn't aware of the organizer.rb. Hmm. Still not giving up on the subfolder idea , what about more closely mimic that Java concept by having under "plugins" max 2..4 letter folders named after the top level domains, e.g. "com", "edu", "org", "net", "tv", "de" or "co"? Isn't the length of TLD's restricted?
The organizer then could just ignore short folder names directly under "plugins", or, if neccessary, have a list of (additional) TLD names to ignore.
Under the TLD folders there would be the appropriate domain name folders of the authors. So someones/Jims/yours/mine plugins would reside in
-
plugins
-
co
-
uk
-
someone
-
someone-else
-
com
-
blogspot
-
sketchuptips* smustard
-
de
-
georg-rehfeld
For the module/class names I'm not any longer really happy with my proposal, because the names would be so exceptionally long/unusabale. Or did I miss some Ruby feature?
Just brainstorming, not more.
Best regards, Georg (aka deerwood)
-
-
I think I'm not seeing what the problem is with having plugins just placed in the root plugins folder?
-
Hi Chris,
as told, I had no name clashes yet in any way. But I see myself "managing" my plugins already, though I'm still a newby.
Especially because there are soooooo many, very helpfull plugins around/published in this forum (wow, thanks to all providers). I have to find a way to try these out and find the ones appropiate for my way of working with SU ... ever changing as I get these new great additions and learn to use them.
And then: Rick warned, I wrote, what came up into my mind. Maybe, that is poor/not appropriate. It is meant as just a base idea ... brain storming, as stupid as it may be, should not be taken literally. Take just one idea out of it or come up with a totally different general approach. Collect as much of ideas as possible. Later on one or the other may be able to make use of the idea.
Best regards, Georg/deerwood
-
Good thread. I may get in to a large ruby project soon, and I'm glad I ran across this. Will give me insight on how best to name and organize my code/scripts.
-
I don't like the initials idea. I'm probably here early enough to lock up "mr" but Mike Roberts and Mary Ryan may not be so happy when they get here next year.
The Java sort-of-standard proposed by Sun (inverted website names) never got popular. Too long. A ten-pound cure for a one-pound problem.
I think that using the name of the plugin should be SOP. VisMap is in a module named VisMap. That means that before you release anything, you Google it, which is a good idea for a lot of reasons.
A Wiki or Google doc re bad plugins would be most helpful. "X is bad" is not helpful, but "X is bad because..." would tell you what not to do so that you don't end up on the bad list.
Advertisement