Struttura ideale del progetto rubino

Question

Sto cercando una panoramica/chiarimento della struttura di progetto ideale per un progetto ruby ​​(non-rails/merb/etc). Sto indovinando che segue le linee di:

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 

Ho qualcosa di sbagliato? Quali parti ho perso?

Answer 1

Penso che sia praticamente perfetto. Per impostazione predefinita, Rubygems aggiungerà la directory lib al percorso di caricamento, ma è possibile inserire qualsiasi directory su quella utilizzando la variabile $:. vale a dire

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

Questo significa che quando si è dire surfer.rb in quel dir, è possibile require "surfer" ovunque e sarà trovato il file.

Inoltre, come convenzione, le classi e i singleton ottengono un file e i moduli ottengono una directory. Per esempio, se si ha il modulo LolCatz e la classe LolCatz::Moar che sarebbe simile:

lib/ 
    appname.rb 
    lolcatz/ 
    moar.rb 

Ecco perché c'è una cartella lib/appname perché la maggior parte le biblioteche sono nel appname namespace.

Inoltre, se si tenta di eseguire il comando newgem --simple [projectname] che genererà rapidamente uno scaffold per voi con solo gli elementi essenziali per un progetto Ruby (e per estensione un Ruby Gem). Ci sono altri strumenti che lo fanno, lo so, ma newgem è piuttosto comune. Di solito mi libero del file TODO e di tutte le cose degli script.

Answer 2

Tento di imitare la struttura del progetto Rails perché il mio team, che di solito si occupa di Rails, capirà la struttura meglio di un'altra configurazione. Convenzione sulla configurazione: dissanguamento da Rails.

Answer 3

vedere il seguente esempio da http://guides.rubygems.org/what-is-a-gem/

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