Estructura de proyecto de ruby ​​ideal

Question

Estoy buscando una visión general/aclaración de la estructura de proyecto ideal para un proyecto ruby ​​(non-rails/merb/etc). Supongo que sigue a lo largo de las líneas de:

app/ 
    bin/     #Files for command-line execution 
    lib/ 
    appname.rb 
    appname/   #Classes and so on 
    Rakefile    #Running tests 
    README 
    test,spec,features/ #Whichever means of testing you go for 
    appname.gemspec  #If it's a gem 

¿Tengo algo malo? ¿Qué partes he perdido?

Answer 1

Creo que es bastante acertado. Por defecto, Rubygems agregará el directorio lib a la ruta de carga, pero puede insertar cualquier directorio al que quiera utilizando la variable $ :. es decir,

$:.push File.expand_path(File.dirname(__FILE__) + '/../surfcompstuff') 

Eso significa que cuando haya decir, surfer.rb en ese directorio, puede require "surfer" en cualquier lugar y el archivo será encontrado.

Además, como una convención, las clases y los singletons obtienen un archivo y los módulos obtienen un directorio. Por ejemplo, si usted tenía el módulo LolCatz y la clase LolCatz::Moar que se vería así:

lib/ 
    appname.rb 
    lolcatz/ 
    moar.rb 

Es por eso que hay una carpeta lib/nombreaplic porque la mayoría de las bibliotecas se encuentran en el espacio de nombres appname.

Además, si intenta ejecutar el comando newgem --simple [projectname] que generará rápidamente un andamio para usted con los elementos esenciales para un proyecto de Ruby (y por extensión, una gema de Ruby). Hay otras herramientas que hacen esto, lo sé, pero newgem es bastante común. Por lo general, me deshago del archivo TODO y todas las cosas del script.

Answer 2

Intento imitar la estructura del proyecto Rails porque mi equipo, que generalmente trabaja con Rails, entenderá la estructura mejor que otra configuración. Convención sobre configuración: desbordamiento de Rails.

Answer 3

Véase el siguiente ejemplo de http://guides.rubygems.org/what-is-a-gem/

% tree freewill 
    freewill/ 
    ├── bin/ 
    │ └── freewill 
    ├── lib/ 
    │ └── freewill.rb 
    ├── test/ 
    │ └── test_freewill.rb 
    ├── README 
    ├── Rakefile 
    └── freewill.gemspec