On Fri, May 7, 2010 at 1:16 PM, Brett <
webf...@gmail.com> wrote:
> Is there anyway I can clean up my
> mess in a way you can get a handle on it?
I don't know. But starting with a fresh copy of FW/1 and only making
the route changes would at least let me look at the implications of
what you're trying to do :)
Also, working with git is very different to SVN. git commits can (and
should) be very small, isolated changes (preferably working changes
but not necessarily :). Pushes should be of collections of commits
that together make up a single working new feature. I pulled your
Google Groups link in README because it was a clean, simple commit.
But your route commit changed a lot of code that wasn't relevant. You
also introduced methods out of alphabetical order (although method
insertion is an easy thing to merge - I'd just commit that and then,
in a separate commit, move the method to where it should be).
> As more people get involved we might want to think about putting up a
> coding conventions page on the wiki.
Just follow the coding conventions already in the code.
That's a standard "best practice" in open source: you follow what's
already there and you do not change surrounding code.
> I'm loving the framework, but I think the code can be cleaned up quite
> a bit and that would also help with these issues moving forward.
Ryan has done a great job of "cleaning up" whilst keeping the style
consistent so I'd like others to follow his lead.
When you work on open source projects, part of the benefit is learning
to subdue your own preferences and follow those expressed by the
existing code and project leads. What looks like "cleaning up" to you
might be horrible style to them. That applies to whitespace, braces,
capitalization, naming conventions and so on. That's a good skill for
team development in general, whenever you join a project that is
already in progress.
Trying to change an existing project's "style" is usually an exercise
in frustration (for everyone involved).
> I was also curious if there are any unit tests writing for FW/1?
I'd be very interested in folks contributing unit tests. Due to the
nature of FW/1 - a single component that must be extended and whose
behaviors are mostly side-effects on the request lifecycle - it isn't
as easy to write tests for as you might think. I did at one point try
to write some cfSpec tests but didn't get very far.
FWIW, John Paul Ashenfelter ran into the same problem trying to write
unit tests for Fusebox.
That's not to say frameworks are inherently hard to test, but some of
FW/1's principles run counter to best practices for testability - and
a framework's internal principles are not (generally) reflective of
best practices for application code, since frameworks have to jump
thru some weird hoops in order to make it easier for developers to use
the framework.
--
Sean A Corfield -- (904) 302-SEAN
Railo Technologies, Inc. --
http://getrailo.com/
An Architect's View --
http://corfield.org/