ruby-on-rails - Ruby gem 命名约定

Question

我正在创建一个 ruby gem ，我注意到似乎没有(据我所知) gem 的命名约定。例如，我已经看到了:

gem 'foo-bar'
gem 'foo_bar'

是否有某种关于 ruby 命名的权威指南/惯例？

Answer 1

虚线版本用于其他框架的扩展，例如 rspec-rails，下划线用于普通 gem 名称的一部分，应在您的类中使用驼峰式命名。

因此，如果您有一个名为 foo_bar 的 gem，则该类/模块应命名为 FooBar。如果那个 gem 应该有一个作为不同 gem 发布的 rails 扩展，它应该被称为 foo_bar-rails 并且该模块应该被称为 FooBar::Rails 并且它应该是要求为 require "foo_bar/rails"

这个约定也是 Bundler 试图要求的。

诚然，并不总是遵循此约定。 jquery_rails 实际上应该是 jquery-rails 而 factory_girl_rails 应该叫做 factory_girl-rails。但是，嘿，并非一切都是完美的。

RubyGems 约定文档:

• Naming gems
• Naming patterns
• Make your own gem