Re: The Well Tempered Ruby Application

James Britt <[email protected]> Thu, 14 Sep 2006 16:09:18 -0700
Newsgroups gmane.comp.lang.ruby.documentation
Organization ruby-doc.org
Message-ID <[email protected]>
Tim Becker wrote:

> I agree that these topics are highly contentious, but there's also a
> number of things, everyone can agree on (e.g. tabs or spaces aren't as
> important as consistency in general, it's ok to break rules, but not
> for the sake of breaking the rules, packages should generally contain
> a README file, etc.)

Absolutely, and if nothing else people can use a guideline to at least 
let them know what things they should be considering.

I think that people who may issues with this or application layout 
already have their own habits and reasons, and there's probably little 
to gain in trying trying change their minds on things.

Of real value is providing guidance to people who no real idea of what 
to do.

> 
>> I want to gem up various parts I decided to go see how people
>> structure their gem dirs.
> 
> 
> Remember any of the good ones?


No. :)  Well, I think most I saw were good, or good enough and 
consistent. I looked at a handful, saw some common layout, and just went 
with it:

bin/
doc/
lib/
test/
examples/

and my Rakefile gem tasks gives me a pkg dir as well with packaged code 
(gem, tgz, zip).

INSTALL and README live in the root folder.


Now, my current project doesn't have (so far, at least) any data files, 
nor is the actual code complex (2 files right now).  So my lib/ has the 
2 source files I need.  I may, though, end up needing to break out 
variable behavior from core code, and then I'll have to think about the 
folders under lib/.

James