2014-02-09 9 views
1

Предполагая, что я создаю проект Ruby Ruby, который не обязательно является веб-проектом, как должна выглядеть моя файловая структура? Мои требования:Какова стандартная файловая структура проекта Ruby?

  • Имеет механизм включения драгоценных камней (Gemfile в корне наиболее вероятно)
  • позволяет запускать Рубиновый файл напрямую, но может также служить в качестве библиотеки

Моего колотой при идее есть:

proj 
--> .ruby-version 
--> .ruby-gemset 
--> lib 
----> proj.rb 
--> Gemfile 
--> README 
--> run.rb (which requires the proj.rb in lib/ and uses it to do work) 

Есть ли какие-либо соображения, которые я должен учитывать, планирую ли я сделать Ruby Gem?

ответ

3

Существует не обязательно какой-либо способ определить проект Ruby. Но, как правило, имеет RubyGems этой файловую структуру:

. 
├── bin 
│   └── mygem 
├── Gemfile 
├── lib 
│   ├── mygem 
│   │   └── version.rb 
│   └── mygem.rb 
├── LICENSE 
├── mygem.gemspec 
├── Rakefile 
└── README.md 

Конечно, есть и другие каталоги и файлы в корневом каталоге проекта, для испытаний, .ruby-version и т.д.

+0

спасибо! Если '/ bin/mygem' является чистым Ruby, то он все равно соглашается сохранить его как' mygem', а не 'mygem.rb'? – franksort

+1

Да, все файлы в 'bin' обычно не должны иметь расширение. Но не забудьте добавить в файл Ruby shebang ('#!/Usr/bin/env ruby'). – JesseG17

Смежные вопросы