From: Trans <transfire@...>
Date: 2008-08-14T03:47:38+09:00
Subject: Re: Ruby projects code organization



On Aug 13, 11:54 am, Simon COURTOIS <happyn...@free.fr> wrote:
> Hi all,
>
> I'm finishing the first version of a project. I want to prepare it to
> distribution.
> It seems there is no standard about ruby projects code organization.
> Is there any ?

There are some general standards. Best place to start:

  http://i.loveruby.net/en/projects/setup/doc/devel.html

Beyond that, Hoe, a popular project management tool, defines a minimal
superset of this --if you want to use it.

I have started adding an admin/ directory to my projects to place all
administrative files. This helps separate the distributable files from
the files I use only for development. It also keeps the project root
directory from getting so huge. For example, my projects will look
something like this:

  myapp/
    COPYING
    HISTORY
    MANIFEST
    METADATA
    NEWS
    README
    admin/
      build/
      config/
      depot/
      forms/
      log/
      notes/
      pkg/
      plugins/
      website/
    bin/
    demo/
    data/
    etc/
    doc/
      rdoc/
      ri/
    lib/
      myapp/
    man/
    script/
    test/

This is the full spread, many of these locations aren't needed for
every project.

T.