blocks|key|1611404|text|我认为这是非常正确的。默认情况下，Rubygems会将lib目录添加到装入路径中，但您可以使用$：变量将任何您想要的目录推入到该目录中。即|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1611405|$:.push+File.expand_path(File.dirname(__FILE__)+%2B+'/../surfcompstuff')|code-block|syntax|javascript|1611406|这意味着当您在目录中输入surfer.rb时，您可以require+"surfer"+anywhere并找到该文件。|offset|length|style|CODE|1611407|同样，按照惯例，类和单例获取一个文件，模块获取一个目录。例如，如果您有LolCatz模块和LolCatz::Moar类，它将如下所示：|1611408|lib/
++appname.rb
++lolcatz/
++++moar.rb|1611409|这就是存在lib/appname文件夹的原因，因为大多数库都在appname名称空间中。|1611410|此外，如果您尝试运行newgem+--simple+[projectname]命令，它将很快为您生成一个脚手架，其中只包含Ruby项目的基本要素(扩展为Ruby+Gem)。我知道还有其他工具可以做到这一点，但newgem很常见。我通常会去掉TODO文件和所有的脚本。|1611411|entityMap^0|0|0|C|9|Q|G|0|Z|7|19|D|0|0|V|7|0|A|T|0^^$0|@$1|2|3|4|5|6|7|W|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|X|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|Y|8|@$I|Z|J|10|K|L]|$I|11|J|12|K|L]]|9|@]|A|$]]|$1|M|3|N|5|6|7|13|8|@$I|14|J|15|K|L]|$I|16|J|17|K|L]]|9|@]|A|$]]|$1|O|3|P|5|D|7|18|8|@]|9|@]|A|$E|F]]|$1|Q|3|R|5|6|7|19|8|@$I|1A|J|1B|K|L]]|9|@]|A|$]]|$1|S|3|T|5|6|7|1C|8|@$I|1D|J|1E|K|L]]|9|@]|A|$]]|$1|U|3|-4|5|6|7|1F|8|@]|9|@]|A|$]]]|V|$]]

I think that is pretty much spot on. By default, Rubygems will add the lib directory to the loadpath, but you can push any directory you want onto that using the $: variable. i.e.

<pre><code>$:.push File.expand_path(File.dirname(__FILE__) + '/../surfcompstuff')
</code></pre>

That means when you have say, <code>surfer.rb</code> in that dir, you can <code>require "surfer"</code> anywhere and the file will be found.

Also, as a convention, classes and singletons get a file and modules get a directory. For instance, if you had the <code>LolCatz</code> module and the <code>LolCatz::Moar</code> class that would look like:

<pre><code>lib/
 appname.rb
 lolcatz/
 moar.rb
</code></pre>

That is why there is an lib/appname folder because most libraries are in the <code>appname</code> namespace.

Additionally, if you try running the command <code>newgem --simple [projectname]</code> that'll quickly generate a scaffold for you with just the bare essentials for a Ruby project (and by extension a Ruby Gem). There are other tools which do this, I know, but newgem is pretty common. I usually get rid of the TODO file and all the script stuff.

blocks|key|1396606|text|我尝试模仿Rails项目结构，因为我的团队通常处理Rails，他们会比另一个配置更好地理解该结构。约定重于配置-从Rails中渗出。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1396607|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

I attempt to mimic the Rails project structure because my team, which usually deals with Rails, will understand the structure better than another configuration. Convention over Configuration - bleeding over from Rails.

blocks|key|1396659|text|请参阅来自http://guides.rubygems.org/what-is-a-gem/的以下示例|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|1396660|+%25+tree+freewill
++++freewill/
++++├──+bin/
++++│+++└──+freewill
++++├──+lib/
++++│+++└──+freewill.rb
++++├──+test/
++++│+++└──+test_freewill.rb
++++├──+README
++++├──+Rakefile
++++└──+freewill.gemspec|code-block|syntax|javascript|1396661|entityMap|0|LINK|mutability|MUTABLE|url|http://guides.rubygems.org/what-is-a-gem/^0|5|15|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@$A|R|B|S|1|T]]|C|$]]|$1|D|3|E|5|F|7|U|8|@]|9|@]|C|$G|H]]|$1|I|3|-4|5|6|7|V|8|@]|9|@]|C|$]]]|J|$K|$5|L|M|N|C|$O|P]]]]

See the following example from <a href="http://guides.rubygems.org/what-is-a-gem/" rel="noreferrer">http://guides.rubygems.org/what-is-a-gem/</a> 

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

blocks|key|1611592|text|如果您使用bundler，运行此命令bundle+gem+app_name将得到相同的目录结构。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|1611593|如果你想使用rspec而不是单元测试，那么你可以运行这个命令rspec+--init+(只需确保你首先使用cd+app_name+)|1611594|entityMap^0|I|J|0|U|C|1H|B|0^^$0|@$1|2|3|4|5|6|7|J|8|@$9|K|A|L|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|M|8|@$9|N|A|O|B|C]|$9|P|A|Q|B|C]]|D|@]|E|$]]|$1|H|3|-4|5|6|7|R|8|@]|D|@]|E|$]]]|I|$]]

If you use bundler, running this command <code>bundle gem app_name</code> will give you the same directory structure.

If you want to use rspec instead of unit tests you can then run this command <code>rspec --init</code>
(Just make sure you <code>cd app_name</code> first)

I'm after an overview/clarification of the ideal project structure for a ruby (non-rails/merb/etc) project. I'm guessing it follows

<pre><code>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
</code></pre>

Have I got something wrong? What parts have I missed out?

Ideal Ruby project structure

单元测试

我想了解一下ruby (非rails/merb/等)项目的理想项目结构。我猜是这样的app/  bin/                  #Files for command-line execution  lib/    appname.rb    appname/            #Classes and ...

问理想的Ruby项目结构
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问理想的Ruby项目结构EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问理想的Ruby项目结构
EN