โครงสร้างโครงการ Ruby ในอุดมคติ

ฉันตามภาพรวม / ชี้แจงโครงสร้างโครงการที่เหมาะสำหรับโครงการทับทิม (ไม่ใช่ราง / merb / etc) ฉันคาดเดาตามนี้

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

ฉันมีอะไรผิดปกติหรือเปล่า? ฉันพลาดส่วนใดไปบ้าง

ฉันคิดว่านั่นเป็นจุดที่น่าสนใจมาก ตามค่าเริ่มต้น Rubygems จะเพิ่มไดเร็กทอรี lib ไปยัง loadpath แต่คุณสามารถพุชไดเร็กทอรีใด ๆ ที่คุณต้องการไปยังไดเร็กทอรีนั้นโดยใช้ตัวแปร $: กล่าวคือ

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

นั่นหมายความว่าเมื่อคุณพูดsurfer.rbใน dir นั้นคุณสามารถทำได้require "surfer"ทุกที่และไฟล์จะพบ

นอกจากนี้ตามแบบแผนคลาสและซิงเกิลได้รับไฟล์และโมดูลจะได้รับไดเร็กทอรี ตัวอย่างเช่นหากคุณมีLolCatzโมดูลและLolCatz::Moarคลาสที่จะมีลักษณะดังนี้:

lib/
  appname.rb
  lolcatz/
    moar.rb

นั่นคือเหตุผลที่มีโฟลเดอร์ lib / appname เนื่องจากไลบรารีส่วนใหญ่อยู่ในappnameเนมสเปซ

นอกจากนี้หากคุณลองเรียกใช้คำสั่งnewgem --simple [projectname]ที่จะสร้างโครงสำหรับคุณอย่างรวดเร็วโดยมีเพียงสิ่งจำเป็นสำหรับโปรเจ็กต์ Ruby (และโดยการขยาย Ruby Gem) มีเครื่องมืออื่น ๆ ที่ทำสิ่งนี้ได้ แต่ newgem นั้นค่อนข้างธรรมดา ฉันมักจะกำจัดไฟล์ TODO และสิ่งที่เป็นสคริปต์ทั้งหมด

ดูตัวอย่างต่อไปนี้จากhttp://guides.rubygems.org/what-is-a-gem/

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

ฉันพยายามเลียนแบบโครงสร้างโครงการ Rails เนื่องจากทีมของฉันซึ่งมักจะเกี่ยวข้องกับ Rails จะเข้าใจโครงสร้างได้ดีกว่าการกำหนดค่าอื่น Convention over Configuration - เลือดออกจาก Rails

หากคุณใช้บันเดิลเลอร์การรันคำสั่งนี้bundle gem app_nameจะทำให้คุณมีโครงสร้างไดเร็กทอรีเดียวกัน

หากคุณต้องการใช้ rspec แทนการทดสอบหน่วยคุณสามารถรันคำสั่งนี้ได้rspec --init (ตรวจสอบให้แน่ใจcd app_nameก่อน)