blocks|key|233765|text|以下是我最常看到的约定(假设您的项目名称为"foo")：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|233766|Foo.rb//|233767|-定义项目的顶级命名空间及其版本；需要files.|unordered-list-item|233768|/lib/foo/+-包含项目的所有类，包括与错误相关的classes.|233769|/test/+-包含project.|233770|/spec/的测试-包含项目的规范。|233771|//-如果项目依赖于二进制文件(JAR文件等)，则通常会将它们放入其中。|233772|233773|在lib/中，约定通常是为顶级名称空间中的每个子名称空间创建一个文件夹。例如，类Foo::Bar::Baz通常位于/lib/foo/bar/baz.rb下。|233774|有些人喜欢创建一个/lib/foo/version.rb文件来设置Foo::VERSION常量，但是我经常在/lib/foo.rb文件中看到这个常量。|233775|此外，如果要创建gem，则需要以下文件：|233776|gem).|233777|/Gemfile+|233778|
|233779|/Rakefile-定义gem).|233780|233781|/Gemfile任务(例如用于测试、构建和推送things).|233782|233783|/foo.gemspec的任务)-定义gem的源(以及其他可能的rake+-描述gem并提供rake列表|233784|233785|entityMap^0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|1C|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|1D|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|1E|8|@]|9|@]|A|$]]|$1|G|3|H|5|F|7|1F|8|@]|9|@]|A|$]]|$1|I|3|J|5|F|7|1G|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|1H|8|@]|9|@]|A|$]]|$1|M|3|N|5|F|7|1I|8|@]|9|@]|A|$]]|$1|O|3|-4|5|6|7|1J|8|@]|9|@]|A|$]]|$1|P|3|Q|5|6|7|1K|8|@]|9|@]|A|$]]|$1|R|3|S|5|6|7|1L|8|@]|9|@]|A|$]]|$1|T|3|U|5|6|7|1M|8|@]|9|@]|A|$]]|$1|V|3|W|5|6|7|1N|8|@]|9|@]|A|$]]|$1|X|3|Y|5|F|7|1O|8|@]|9|@]|A|$]]|$1|Z|3|10|5|6|7|1P|8|@]|9|@]|A|$]]|$1|11|3|12|5|F|7|1Q|8|@]|9|@]|A|$]]|$1|13|3|10|5|6|7|1R|8|@]|9|@]|A|$]]|$1|14|3|15|5|F|7|1S|8|@]|9|@]|A|$]]|$1|16|3|10|5|6|7|1T|8|@]|9|@]|A|$]]|$1|17|3|18|5|F|7|1U|8|@]|9|@]|A|$]]|$1|19|3|-4|5|6|7|1V|8|@]|9|@]|A|$]]|$1|1A|3|-4|5|6|7|1W|8|@]|9|@]|A|$]]]|1B|$]]

Here are the conventions I have most often seen (assuming your project's name is "foo"):

<ul>
<li>/lib/foo.rb - Defines the top-level namespace of the project and its version; requires needed files.</li>
<li>/lib/foo/ - Contains all classes for your project, including error-related classes.</li>
<li>/test/ - Contains tests for your project.</li>
<li>/spec/ - Contains the specs for your project.</li>
<li>/bin/ - If your project depends on binaries (JAR files, etc.), they usually go in there.</li>
</ul>

Inside lib/, the convention is usually to create a folder for each sub-namespace inside your top-level namespace. For example, the class Foo::Bar::Baz is usually found under /lib/foo/bar/baz.rb.

Some people like to create a /lib/foo/version.rb file just to set the Foo::VERSION constant, but very often I have seen this defined in the /lib/foo.rb file.

Also, if you are creating a gem, you will need the following files:

<ul>
<li>/Rakefile - Defines rake tasks (such as tasks for testing, building and pushing the gem).</li>
<li>/Gemfile - Defines the source of the gem (among other possible things).</li>
<li>/foo.gemspec - Describes your gem and provides a list of dependencies.</li>
</ul>

blocks|key|2901793|text|为了获得一个好的开始，您可以使用bundle+gem命令和rspec+--init。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|2901794|~/code+$+bundle+gem+my_lib
++++++create++my_lib/Gemfile
++++++create++my_lib/Rakefile
++++++create++my_lib/LICENSE.txt
++++++create++my_lib/README.md
++++++create++my_lib/.gitignore
++++++create++my_lib/my_lib.gemspec
++++++create++my_lib/lib/my_lib.rb
++++++create++my_lib/lib/my_lib/version.rb
Initializating+git+repo+in+/Users/john/code/my_lib
~/code+$+cd+my_lib/
~/code/my_lib+$+git+commit+-m+"Empty+project"
~/code/my_lib+$+rspec+--init
The+--configure+option+no+longer+needs+any+arguments,+so+true+was+ignored.
++create+++spec/spec_helper.rb
++create+++.rspec|code-block|syntax|javascript|2901795|ruby代码放在lib|2901796|specs中，数据放在spec|unordered-list-item|2901797|
|2901798|test中，文档放在spec/fixtures/|2901799|2901800|Require中，所有文件都放在lib/my_lib.rb中。您也可以在该文件或它们自己的文件中定义异常--根据您自己的preference.|2901801|C源文件放在ext/my_lib|2901802|shell脚本中，可执行文件放在bin|2901803|中|2901804|2901805|如果有疑问，只需看看其他gem是如何布局的。|2901806|2901807|更多信息：|2901808|您应该将rspec作为开发依赖项添加到您的gemspec中，以使其他开发人员更容易操作|2901809|2901810|编辑规范，在底部附近添加gem.add_development_dependency+'rspec'和gem.add_development_dependency+'rake'。|ordered-list-item|2901811|将Bundler.setup和require+'my_lib'添加到spec/spec_helper.rb的顶部，以确保在运行规范时加载gem依赖项。|2901812|<代码>H132将D33和D34添加到Rakefile中，以便运行D35将运行您的规范。<代码>G237|2901813|当您正在进行最新的创建时，guard-rspec可以在文件更改时自动运行您的规范，提醒您规范失败，从而节省您的时间和麻烦。|2901814|~/code/my_lib+$+git+add+spec/spec_helper.rb
~/code/my_lib+$+git+commit+-am+"Add+RSpec"
~/code/my_lib+$+vim+my_lib.gemspec+#+add+guard+development+dependency
~/code/my_lib+$+bundle
~/code/my_lib+$+bundle+exec+guard+init
~/code/my_lib+$+vim+Guardfile+#+Remove+the+sections+below+the+top+one
~/code/my_lib+$+git+add+Guardfile
~/code/my_lib+$+git+commit+-am+"Add+Guard"|2901815|创建满意后，将其推送到github|2901816|#+create+a+github+repository+for+your+gem,+then+push+it+up
~/code/my_lib+$+curl+-u+myusername+https://api.github.com/user/repos+-d+'{"name":"my_lib"}'+
~/code/my_lib+$+git+remote+add+origin+git@github.com:myusername/my_lib.git
~/code/my_lib+$+git+push|2901817|然后，当您准备好在Rubygems.org上发布您的gem时，运行rake+release，它将引导您完成这些步骤。|2901818|~/code/my_lib+$+rake+release|2901819|进一步的参考文献|2901820|2901821|+Rubygems+patterns+guide+(和home+page)，来自马修斯·莫雷拉的答案。来自Zed+Shaw在Railscasts|2901822|docs|2901823|上的Learn+Ruby+The+Hard+Way|2901824|New+Gem+with+Bundler视频的Steve+Klabnik|2901825|2901826|Exercise+46:+A+Project+Skeleton的references|2901827|2901828|How+I+Start真的很棒|2901829|2901830|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/guard/guard-rspec|1|https://guides.rubygems.org/patterns/|2|https://guides.rubygems.org/|3|https://bundler.io/v1.10/bundle_gem.html|4|https://learnrubythehardway.org/book/|5|http://railscasts.com/episodes/245-new-gem-with-bundler|6|https://learnrubythehardway.org/book/ex46.html|7|https://howistart.org/posts/ruby/1/^0|G|A|T|C|0|0|8|3|0|B|4|0|0|A|E|0|0|G|D|0|6|A|0|G|3|0|0|0|0|0|0|0|0|C|12|1F|11|0|1|D|F|G|0|0|D|B|0|0|0|0|0|X|C|0|0|0|0|1|N|1|R|9|2|0|0|4|3|0|2|N|4|0|0|K|5|0|0|0|V|6|0|0|0|B|7|0|0^^$0|@$1|2|3|4|5|6|7|2Y|8|@$9|2Z|A|30|B|C]|$9|31|A|32|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|33|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|34|8|@$9|35|A|36|B|C]]|D|@]|E|$]]|$1|M|3|N|5|O|7|37|8|@$9|38|A|39|B|C]]|D|@]|E|$]]|$1|P|3|Q|5|6|7|3A|8|@]|D|@]|E|$]]|$1|R|3|S|5|O|7|3B|8|@$9|3C|A|3D|B|C]]|D|@]|E|$]]|$1|T|3|Q|5|6|7|3E|8|@]|D|@]|E|$]]|$1|U|3|V|5|O|7|3F|8|@$9|3G|A|3H|B|C]]|D|@]|E|$]]|$1|W|3|X|5|O|7|3I|8|@$9|3J|A|3K|B|C]]|D|@]|E|$]]|$1|Y|3|Z|5|O|7|3L|8|@$9|3M|A|3N|B|C]]|D|@]|E|$]]|$1|10|3|11|5|6|7|3O|8|@]|D|@]|E|$]]|$1|12|3|-4|5|6|7|3P|8|@]|D|@]|E|$]]|$1|13|3|14|5|6|7|3Q|8|@]|D|@]|E|$]]|$1|15|3|-4|5|6|7|3R|8|@]|D|@]|E|$]]|$1|16|3|17|5|6|7|3S|8|@]|D|@]|E|$]]|$1|18|3|19|5|6|7|3T|8|@]|D|@]|E|$]]|$1|1A|3|-4|5|6|7|3U|8|@]|D|@]|E|$]]|$1|1B|3|1C|5|1D|7|3V|8|@$9|3W|A|3X|B|C]|$9|3Y|A|3Z|B|C]]|D|@]|E|$]]|$1|1E|3|1F|5|1D|7|40|8|@$9|41|A|42|B|C]|$9|43|A|44|B|C]]|D|@]|E|$]]|$1|1G|3|1H|5|6|7|45|8|@]|D|@]|E|$]]|$1|1I|3|1J|5|6|7|46|8|@]|D|@$9|47|A|48|1|49]]|E|$]]|$1|1K|3|1L|5|H|7|4A|8|@]|D|@]|E|$I|J]]|$1|1M|3|1N|5|6|7|4B|8|@]|D|@]|E|$]]|$1|1O|3|1P|5|H|7|4C|8|@]|D|@]|E|$I|J]]|$1|1Q|3|1R|5|6|7|4D|8|@$9|4E|A|4F|B|C]]|D|@]|E|$]]|$1|1S|3|1T|5|H|7|4G|8|@]|D|@]|E|$I|J]]|$1|1U|3|1V|5|6|7|4H|8|@]|D|@]|E|$]]|$1|1W|3|-4|5|6|7|4I|8|@]|D|@]|E|$]]|$1|1X|3|1Y|5|O|7|4J|8|@]|D|@$9|4K|A|4L|1|4M]|$9|4N|A|4O|1|4P]]|E|$]]|$1|1Z|3|20|5|O|7|4Q|8|@]|D|@$9|4R|A|4S|1|4T]]|E|$]]|$1|21|3|22|5|6|7|4U|8|@]|D|@$9|4V|A|4W|1|4X]]|E|$]]|$1|23|3|24|5|O|7|4Y|8|@]|D|@$9|4Z|A|50|1|51]]|E|$]]|$1|25|3|Q|5|6|7|52|8|@]|D|@]|E|$]]|$1|26|3|27|5|O|7|53|8|@]|D|@$9|54|A|55|1|56]]|E|$]]|$1|28|3|Q|5|6|7|57|8|@]|D|@]|E|$]]|$1|29|3|2A|5|O|7|58|8|@]|D|@$9|59|A|5A|1|5B]]|E|$]]|$1|2B|3|-4|5|6|7|5C|8|@]|D|@]|E|$]]|$1|2C|3|-4|5|6|7|5D|8|@]|D|@]|E|$]]]|2D|$2E|$5|2F|2G|2H|E|$2I|2J]]|2K|$5|2F|2G|2H|E|$2I|2L]]|2M|$5|2F|2G|2H|E|$2I|2N]]|2O|$5|2F|2G|2H|E|$2I|2P]]|2Q|$5|2F|2G|2H|E|$2I|2R]]|2S|$5|2F|2G|2H|E|$2I|2T]]|2U|$5|2F|2G|2H|E|$2I|2V]]|2W|$5|2F|2G|2H|E|$2I|2X]]]]

To get a good start, you can use the <code>bundle gem</code> command and <code>rspec --init</code>.

<pre><code>~/code $ bundle gem my_lib
 create my_lib/Gemfile
 create my_lib/Rakefile
 create my_lib/LICENSE.txt
 create my_lib/README.md
 create my_lib/.gitignore
 create my_lib/my_lib.gemspec
 create my_lib/lib/my_lib.rb
 create my_lib/lib/my_lib/version.rb
Initializating git repo in /Users/john/code/my_lib
~/code $ cd my_lib/
~/code/my_lib $ git commit -m "Empty project"
~/code/my_lib $ rspec --init
The --configure option no longer needs any arguments, so true was ignored.
 create spec/spec_helper.rb
 create .rspec
</code></pre>

<ul>
<li>code goes in <code>lib</code></li>
<li>specs go in <code>spec</code></li>
<li>test data or documents go in <code>spec/fixtures/</code></li>
<li>Require all your ruby files in <code>lib/my_lib.rb</code>. You can define your exceptions in that file, too, or in their own files -- according to your own preference.</li>
<li>C source files go in <code>ext/my_lib</code></li>
<li>shell scripts and executables go in <code>bin</code></li>
</ul>

When in doubt, just look at how other gems are laid out.

<hr>

Further information:

You should add rspec as a development dependency in your gemspec to make things easier for other developers

<ol>
<li>Edit my_lib.gemspec, adding <code>gem.add_development_dependency 'rspec'</code> and <code>gem.add_development_dependency 'rake'</code> near the bottom.</li>
<li>Add <code>Bundler.setup</code> and <code>require 'my_lib'</code> to the top of spec/spec_helper.rb to ensure your gem dependencies are loaded when you run your specs.</li>
<li>Add <code>require "rspec/core/rake_task"</code> and <code>task :default =&gt; :spec</code> to your Rakefile, so that running <code>rake</code> will run your specs.</li>
</ol>

While you're working on your newest creation, <a href="https://github.com/guard/guard-rspec" rel="noreferrer">guard-rspec</a> can save you time and hassle by automatically running your specs as files change, alerting you to spec failures.

<pre><code>~/code/my_lib $ git add spec/spec_helper.rb
~/code/my_lib $ git commit -am "Add RSpec"
~/code/my_lib $ vim my_lib.gemspec # add guard development dependency
~/code/my_lib $ bundle
~/code/my_lib $ bundle exec guard init
~/code/my_lib $ vim Guardfile # Remove the sections below the top one
~/code/my_lib $ git add Guardfile
~/code/my_lib $ git commit -am "Add Guard"
</code></pre>

After you're happy with your creation, push it up to github

<pre><code># create a github repository for your gem, then push it up
~/code/my_lib $ curl -u myusername https://api.github.com/user/repos -d '{"name":"my_lib"}' 
~/code/my_lib $ git remote add origin git@github.com:myusername/my_lib.git
~/code/my_lib $ git push
</code></pre>

Then, when you're ready to release your gem on Rubygems.org, run <code>rake release</code>, which will walk you through the steps.

<pre><code>~/code/my_lib $ rake release
</code></pre>

Further References

<ul>
<li>The <a href="https://guides.rubygems.org/patterns/" rel="noreferrer">Rubygems patterns guide</a> (and <a href="https://guides.rubygems.org" rel="noreferrer">home page</a>), from Matheus Moreira's answer. They're really great references</li>
<li><a href="https://howistart.org/posts/ruby/1/" rel="noreferrer">How I Start</a> by Steve Klabnik</li>
<li><a href="https://learnrubythehardway.org/book/ex46.html" rel="noreferrer">Exercise 46: A Project Skeleton</a> from Zed Shaw's <a href="https://learnrubythehardway.org/book/" rel="noreferrer">Learn Ruby The Hard Way</a></li>
<li><a href="http://railscasts.com/episodes/245-new-gem-with-bundler" rel="noreferrer">New Gem with Bundler</a> video on Railscasts</li>
<li><a href="https://bundler.io/v1.10/bundle_gem.html" rel="noreferrer">docs</a></li>
</ul>

blocks|key|233868|text|有一些some+nice+guides+at+rubygems.org将向您介绍这些约定以及其中一些约定背后的原因。一般来说，大多数Ruby开发人员都遵循Rubygems+naming+and+directory+conventions。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|233869|只有在标准库中找不到符合错误描述的类时，我才会创建自定义异常类。将error类嵌套在引发它的类或模块下：|233870|class+Parser::Error+<+RuntimeError;+end

begin
++Parser.new(:invalid).parse!
rescue+Parser::Error+=>+e
++puts+e.message
end|code-block|syntax|javascript|233871|单元测试要么进入/test，如果你使用Test::Unit，要么进入/spec，如果你使用RSpec。我推荐后者。|style|CODE|233872|Bundler是管理加载路径的一个很好的方法。它将仅使用Gemfile和gemspec上指定的依赖项自动设置您的环境。它还允许您轻松地require您的代码，而不是使它成为宝石。|233873|但是，由于您将来可能会将代码捆绑到gem中，我建议您研究一下how+to+create+gem+specifications。您应该手动编写您的规范。不要使用某些工具来自动生成它-在我看来，它们是蛮力方法，当与源代码控制一起使用时，它们会不必要地复制信息并造成严重破坏。|233874|你可能会发现有用的I+created+a+gem。给定一个gemspec文件，它定义了许多用于处理gem的有用Rake任务，包括构建、安装gem并将其发布到带有自动版本标记的rubygems和git存储库的任务。它还提供了一种在irb或pry会话中加载代码的简单方法。|233875|#+Rakefile
require+'rookie'

#+Run+`rake+-T`+for+the+complete+task+list
Rookie::Tasks.new('your_gem.gemspec').define_tasks!|233876|entityMap|0|LINK|mutability|MUTABLE|url|http://guides.rubygems.org/|1|http://guides.rubygems.org/patterns/|2|http://en.wikibooks.org/wiki/Ruby_Programming/Unit_testing|3|https://www.relishapp.com/rspec|4|http://gembundler.com/|5|http://guides.rubygems.org/make-your-own-gem/#first-gem|6|https://rubygems.org/gems/rookie^0|3|W|0|25|15|1|0|0|0|8|5|J|A|Y|5|19|5|J|A|2|19|5|3|0|0|7|S|7|10|7|1V|7|0|7|4|0|U|W|5|0|T|7|1J|4|2F|8|2O|3|36|3|3A|3|9|F|6|0|0^^$0|@$1|2|3|4|5|6|7|1G|8|@]|9|@$A|1H|B|1I|1|1J]|$A|1K|B|1L|1|1M]]|C|$]]|$1|D|3|E|5|6|7|1N|8|@]|9|@]|C|$]]|$1|F|3|G|5|H|7|1O|8|@]|9|@]|C|$I|J]]|$1|K|3|L|5|6|7|1P|8|@$A|1Q|B|1R|M|N]|$A|1S|B|1T|M|N]|$A|1U|B|1V|M|N]|$A|1W|B|1X|M|N]]|9|@$A|1Y|B|1Z|1|20]|$A|21|B|22|1|23]]|C|$]]|$1|O|3|P|5|6|7|24|8|@$A|25|B|26|M|N]|$A|27|B|28|M|N]|$A|29|B|2A|M|N]|$A|2B|B|2C|M|N]]|9|@$A|2D|B|2E|1|2F]]|C|$]]|$1|Q|3|R|5|6|7|2G|8|@]|9|@$A|2H|B|2I|1|2J]]|C|$]]|$1|S|3|T|5|6|7|2K|8|@$A|2L|B|2M|M|N]|$A|2N|B|2O|M|N]|$A|2P|B|2Q|M|N]|$A|2R|B|2S|M|N]|$A|2T|B|2U|M|N]|$A|2V|B|2W|M|N]]|9|@$A|2X|B|2Y|1|2Z]]|C|$]]|$1|U|3|V|5|H|7|30|8|@]|9|@]|C|$I|J]]|$1|W|3|-4|5|6|7|31|8|@]|9|@]|C|$]]]|X|$Y|$5|Z|10|11|C|$12|13]]|14|$5|Z|10|11|C|$12|15]]|16|$5|Z|10|11|C|$12|17]]|18|$5|Z|10|11|C|$12|19]]|1A|$5|Z|10|11|C|$12|1B]]|1C|$5|Z|10|11|C|$12|1D]]|1E|$5|Z|10|11|C|$12|1F]]]]

There are <a href="http://guides.rubygems.org/" rel="noreferrer">some nice guides at rubygems.org</a> that will introduce you to the conventions and the reasoning behind some of them. In general, the <a href="http://guides.rubygems.org/patterns/" rel="noreferrer">Rubygems naming and directory conventions</a> are followed by most Ruby developers.

I would only create custom exception classes if I wasn't able to find any class in the standard library fits the error description. Nest your error class under the class or module that raises it:

<pre><code>class Parser::Error &lt; RuntimeError; end

begin
 Parser.new(:invalid).parse!
rescue Parser::Error =&gt; e
 puts e.message
end
</code></pre>

Unit tests go either into <code>/test</code>, if you're using <a href="http://en.wikibooks.org/wiki/Ruby_Programming/Unit_testing" rel="noreferrer"><code>Test::Unit</code></a>, or into <code>/spec</code> if you're using <a href="https://www.relishapp.com/rspec" rel="noreferrer"><code>RSpec</code></a>. I recommend the latter.

<a href="http://gembundler.com/" rel="noreferrer"><code>Bundler</code></a> is a great way to manage your load path. It will automatically set up your environment with only the dependencies specified on the <code>Gemfile</code> and optionally the <code>gemspec</code>. It also allows you to easily <code>require</code> your code without making it a gem.

However, since you might bundle your code in a gem in the future, I recommend investigating <a href="http://guides.rubygems.org/make-your-own-gem/#first-gem" rel="noreferrer">how to create gem specifications</a>. You should write your specification manually. Don't use some tool to automagically generate it - they are, in my opinion, brute force approaches that needlessly duplicate information and wreak havoc when used with source control.

<a href="https://rubygems.org/gems/rookie" rel="noreferrer">I created a gem</a> which you may find useful. Given a <code>gemspec</code> file, it defines many useful <code>Rake</code> tasks for working with your gem, which include tasks for building, installing and releasing your gem to <code>rubygems</code> and <code>git</code> repository with automatic version tagging. It also provides an easy way to load your code in a <code>irb</code> or <code>pry</code> session.

<pre><code># Rakefile
require 'rookie'

# Run `rake -T` for the complete task list
Rookie::Tasks.new('your_gem.gemspec').define_tasks!
</code></pre>

blocks|key|236492|text|网上有一些关于如何构建Ruby项目的指南。此外，我认为解决这个问题的最好方法是在github上寻找一些著名的Ruby项目，并检查“它们”的结构。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|236493|除了一般的ruby+gem需求之外，我还推荐以下工具来实现更好的工作流：|236494|236495|editorconfig，帮助开发人员在不同的编辑器和IDEs.|unordered-list-item|offset|length|236496|rubocop之间定义和维护一致的编码风格，静态代码分析器的ruby，在ruby+community.|236497|guard中的defac+to+linter，再加上一堆插件，当代码发生变化时，你可以运行任何命令，automatically.|236498|rake，各种项目任务的通用驱动程序，例如：|236499|package：build+gem+package|style|CODE|236500|clean：clean+generated+files|236501|test：run+test|236502|236503|236504|​|236505|流行的ruby文档工具|236506|yard。|236507|236508|除了上面所有的工具，他们还有一些ruby项目的在线服务：|236509|236510|CI(Continuous集成)+|236511|travis-ci|236512|circleci|236513|codeship|236514|236515|236516|236517|236518|代码审查|236519|codeclimate|236520|236521|236522|236523|你甚至可以通过http://shields.io/为你的开源项目生成徽章。|236524|这是我的经验，希望对某些人有帮助。|236525|entityMap|0|LINK|mutability|MUTABLE|url|http://editorconfig.org/|1|https://github.com/bbatsov/rubocop|2|https://github.com/guard/guard|3|https://github.com/ruby/rake|4|http://yardoc.org/|5|https://travis-ci.org/|6|https://circleci.com/|7|https://codeship.com/|8|https://codeclimate.com/|9|http://shields.io/^0|0|0|0|0|C|0|0|0|7|1|0|0|5|2|0|0|4|3|1|0|7|1|0|5|1|0|4|1|0|0|0|0|0|4|4|0|0|0|0|1|0|9|5|1|0|8|6|1|0|8|7|1|0|0|0|0|1|0|B|8|1|0|0|0|7|I|9|0|0^^$0|@$1|2|3|4|5|6|7|2M|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|2N|8|@]|9|@]|A|$]]|$1|D|3|-4|5|6|7|2O|8|@]|9|@]|A|$]]|$1|E|3|F|5|G|7|2P|8|@]|9|@$H|2Q|I|2R|1|2S]]|A|$]]|$1|J|3|K|5|G|7|2T|8|@]|9|@$H|2U|I|2V|1|2W]]|A|$]]|$1|L|3|M|5|G|7|2X|8|@]|9|@$H|2Y|I|2Z|1|30]]|A|$]]|$1|N|3|O|5|G|7|31|8|@]|9|@$H|32|I|33|1|34]]|A|$]]|$1|P|3|Q|5|G|7|35|8|@$H|36|I|37|R|S]]|9|@]|A|$]]|$1|T|3|U|5|G|7|38|8|@$H|39|I|3A|R|S]]|9|@]|A|$]]|$1|V|3|W|5|G|7|3B|8|@$H|3C|I|3D|R|S]]|9|@]|A|$]]|$1|X|3|-4|5|6|7|3E|8|@]|9|@]|A|$]]|$1|Y|3|-4|5|6|7|3F|8|@]|9|@]|A|$]]|$1|Z|3|10|5|6|7|3G|8|@]|9|@]|A|$]]|$1|11|3|12|5|6|7|3H|8|@]|9|@]|A|$]]|$1|13|3|14|5|G|7|3I|8|@]|9|@$H|3J|I|3K|1|3L]]|A|$]]|$1|15|3|-4|5|6|7|3M|8|@]|9|@]|A|$]]|$1|16|3|17|5|6|7|3N|8|@]|9|@]|A|$]]|$1|18|3|-4|5|6|7|3O|8|@]|9|@]|A|$]]|$1|19|3|1A|5|G|7|3P|8|@]|9|@]|A|$]]|$1|1B|3|1C|5|G|7|3Q|8|@]|9|@$H|3R|I|3S|1|3T]]|A|$]]|$1|1D|3|1E|5|G|7|3U|8|@]|9|@$H|3V|I|3W|1|3X]]|A|$]]|$1|1F|3|1G|5|G|7|3Y|8|@]|9|@$H|3Z|I|40|1|41]]|A|$]]|$1|1H|3|-4|5|6|7|42|8|@]|9|@]|A|$]]|$1|1I|3|-4|5|6|7|43|8|@]|9|@]|A|$]]|$1|1J|3|10|5|6|7|44|8|@]|9|@]|A|$]]|$1|1K|3|-4|5|6|7|45|8|@]|9|@]|A|$]]|$1|1L|3|1M|5|G|7|46|8|@]|9|@]|A|$]]|$1|1N|3|1O|5|G|7|47|8|@]|9|@$H|48|I|49|1|4A]]|A|$]]|$1|1P|3|-4|5|6|7|4B|8|@]|9|@]|A|$]]|$1|1Q|3|-4|5|6|7|4C|8|@]|9|@]|A|$]]|$1|1R|3|10|5|6|7|4D|8|@]|9|@]|A|$]]|$1|1S|3|1T|5|6|7|4E|8|@]|9|@$H|4F|I|4G|1|4H]]|A|$]]|$1|1U|3|1V|5|6|7|4I|8|@]|9|@]|A|$]]|$1|1W|3|-4|5|6|7|4J|8|@]|9|@]|A|$]]]|1X|$1Y|$5|1Z|20|21|A|$22|23]]|24|$5|1Z|20|21|A|$22|25]]|26|$5|1Z|20|21|A|$22|27]]|28|$5|1Z|20|21|A|$22|29]]|2A|$5|1Z|20|21|A|$22|2B]]|2C|$5|1Z|20|21|A|$22|2D]]|2E|$5|1Z|20|21|A|$22|2F]]|2G|$5|1Z|20|21|A|$22|2H]]|2I|$5|1Z|20|21|A|$22|2J]]|2K|$5|1Z|20|21|A|$22|2L]]]]

There're some guides on the internet about how to structure a Ruby project. Besides, I think the best way to solve this is heading over github and looking for some famous Ruby project, and check "their" structures.

Besides general ruby gem requirements, I recommend the following tools for better workflow:

<ul>
<li><a href="http://editorconfig.org/" rel="noreferrer">editorconfig</a> , helps developers define and maintain consistent coding styles between different editors and IDEs.</li>
<li><a href="https://github.com/bbatsov/rubocop" rel="noreferrer">rubocop</a> , static code analyzer for ruby, the defac to linter in ruby community.</li>
<li><a href="https://github.com/guard/guard" rel="noreferrer">guard</a> , together with a bunch of plugins, you can run any commands as you like when code changes, automatically.</li>
<li><a href="https://github.com/ruby/rake" rel="noreferrer">rake</a> , the universal driver for various project tasks, such as:

<ul>
<li><code>package</code>: build gem package</li>
<li><code>clean</code>: clean generated files</li>
<li><code>test</code>: run test</li>
</ul></li>
<li><a href="http://yardoc.org/" rel="noreferrer">yard</a> , popular ruby documentation tool.</li>
</ul>

And besides all of the above tools, their're some online service for ruby project:

<ul>
<li>CI(Continuous Integration)

<ul>
<li><a href="https://travis-ci.org/" rel="noreferrer">travis-ci</a></li>
<li><a href="https://circleci.com/" rel="noreferrer">circleci</a></li>
<li><a href="https://codeship.com/" rel="noreferrer">codeship</a></li>
</ul></li>
<li>Code Review

<ul>
<li><a href="https://codeclimate.com/" rel="noreferrer">codeclimate</a></li>
</ul></li>
</ul>

And you can even genearate badges via <a href="http://shields.io/" rel="noreferrer">http://shields.io/</a> for your open source project.

That's my experience, hope it helps for some one.

I want to create a small Ruby project with 10 ~ 20 classes/files. I need some gems and I want to use RSpec as a test framework.
I might want to build a gem later on, but that is not certain.
Is there some how-to or guide that shows me how to set up the basic structure of my project?
Questions that I have are:
<ul>
<li>Where do I put all my custom Errors/Exceptions?</li>
<li>Are there some conventions out there for naming directories like lib, bin, src etc?</li>
<li>Where do I put test data or documents?</li>
<li>Where do I require all my files so I have access to them in my project?</li>
</ul>
I know I could do everything from scratch, but I would like some guidance. There are some good gems out there that I could copy, but I am not certain what I really need and what I can delete.
I looked at <a href="http://gembundler.com/" rel="nofollow noreferrer">http://gembundler.com/</a>, but it stops after setting up Bundler.

How do I set up a basic Ruby project?

静态代码分析

单元测试

我想创建一个包含10 ~ 20个类/文件的小Ruby项目。我需要一些gem，我想使用RSpec作为测试框架。我可能想稍后构建一个gem，但这并不确定。是否有一些操作指南或指南告诉我如何设置我的项目的基本结构？我的问题是：我应该把我所有的自定义Errors/Exceptions?Are放在哪里有一些命名目录的约定，比如l...

问如何设置一个基本的Ruby项目？
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何设置一个基本的Ruby项目？EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何设置一个基本的Ruby项目？
EN