Cấu trúc dự án ruby ​​lý tưởng

Question

Tôi sau một tổng quan/làm rõ cấu trúc dự án lý tưởng cho một dự án ruby ​​(không rails/merb/etc). Tôi đoán nó tuân theo các dòng:

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 

Tôi có điều gì sai không? Tôi đã bỏ lỡ những phần nào?

Answer 1

Tôi nghĩ rằng đó là khá nhiều điểm trên. Theo mặc định, Rubygems sẽ thêm thư mục lib vào đường dẫn tải, nhưng bạn có thể đẩy bất kỳ thư mục nào bạn muốn vào đó bằng biến $:. ví dụ:

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

Điều đó có nghĩa khi bạn đã nói, surfer.rb trong dir đó, bạn có thể require "surfer" bất cứ nơi nào và tập tin sẽ được tìm thấy.

Ngoài ra, như một quy ước, các lớp học và người độc thân có được một tệp và mô-đun nhận được một thư mục. Ví dụ, nếu bạn có các mô-đun LolCatz và lớp LolCatz::Moar đó sẽ trông giống như:

lib/ 
    appname.rb 
    lolcatz/ 
    moar.rb 

Đó là lý do tại sao có một thư mục lib/appname bởi vì hầu hết các thư viện đang trong namespace appname.

Ngoài ra, nếu bạn thử chạy lệnh newgem --simple [projectname], nó sẽ nhanh chóng tạo ra một giàn giáo cho bạn chỉ với các yếu tố cần thiết cho dự án Ruby (và mở rộng một Gem Ruby). Có những công cụ khác làm điều này, tôi biết, nhưng newgem là khá phổ biến. Tôi thường loại bỏ tệp TODO và tất cả nội dung tập lệnh.

Answer 2

Tôi cố gắng bắt chước cấu trúc dự án Rails vì nhóm của tôi, thường giao dịch với Rails, sẽ hiểu cấu trúc tốt hơn cấu hình khác. Công ước về cấu hình - chảy máu từ Rails.

Answer 3

Xem ví dụ sau đây từ http://guides.rubygems.org/what-is-a-gem/

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