理想的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目录添加到加载路径，但是您可以使用$：变量将所需的任何目录压入该目录。即

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

这意味着当您surfer.rb在该目录中说过时，便可以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合作的团队会比其他配置更好地了解该结构。约定优于配置-从Rails溢出。

如果使用捆绑程序，则运行此命令bundle gem app_name将为您提供相同的目录结构。

如果要使用rspec代替单元测试，则可以运行此命令rspec --init （只需确保cd app_name先执行）