这里是一些命名gem的最佳实践
fancy_require |
require 'fancy_require' |
FancyRequire |
ruby_parser |
require 'ruby_parser' |
RubyParser |
net-http-persistent |
require 'net/http/persistent' |
Net::HTTP::Persistent |
rdoc-data |
require 'rdoc/data' |
RDoc::Data |
autotest-growl |
require 'autotest/growl' |
Autotest::Growl |
net-http-digest_auth |
require 'net/http/digest_auth' |
Net::HTTP::DigestAuth |
这个表格的主要目的就是为你提供在你的gem里面require文件的线索。尊从这个最佳实践也可以使得你Bundler加载gem无需你额外的配置。
如果你发布了一个gem到 rubygems.org
但是他令人讨厌,违反最佳实践或者反人类,那么他将不久于人世。你可以报告给 RubyGems Support site.
一、在多个单词之间使用下划线
如果一个class or module有多个单词,使用下划线分割他们。使用户使用gem更简单。
二、为扩展使用破折号
如果你添加函数到其他gem,使用破折号。他也和require语句中的/和main class or module 中::
的保持一致。
If you’re adding functionality to another gem, use a dash. This usually corresponds to a /
in the require statement (and therefore your gem’s directory structure) and a ::
in the name of your main class or module.
三、适当的混用下划线和破折号
如果你的class or module有多个单词。同时你也添加了函数到其他gem,那么请遵循以上规则。例如
net-http-digest_auth
添加了 HTTP digest authentication 到 net/http
.用户会require 'net/http/digest_auth'
以便使用扩展 (in class Net::HTTP::DigestAuth
)。
四、千万别使用大写字母
OS X and Windows的文件系统默认区分大小写(case-insensitive)。如果用户在非OS X and Windows系统下使用大写字母加载一个gem是不可移植的。这是一个新手常犯的错误,我们没必要被他迷惑。
五、尾声
This guide was expanded from How to Name Gems by Eric Hodel.
相关推荐
gemstash, 一个 RubyGems.org 缓存和 private gem 服务器 什么是 Gemstash?Gemstash是远程服务器( 如 https://rubygems.org ) 和 private gem 源的缓存。在你的控制范围内,如果你使用的是多个可以访问服务器的...
A package (also known as a library) contains a set of functionality that can be invoked by a Ruby program, such as reading and parsing an XML ... See our guide on publishing a Gem at guides.rubygems.org
RubyGems.org(néeGemcutter) Ruby社区的gem主机。 目的 提供更好的API处理宝石 创建更透明,更易于访问的项目页面 使社区能够改善和增强网站 支持 由管理, 是一个社区资助的组织,通过门票和赞助为和的会议...
在Rubygems.org上查看Ruby Toolbox数据 此Chrome扩展程序从Ruby工具箱(https://www.ruby-toolbox.com/)中提取信息,以显示在rubygems.org上。 例如,如果您正在https://rubygems.org/gems/simplecov上查看诸如...
option.rubygems.org 项目导师的姓名: Nick Quaranto,Benjamin Fleischer 项目团队的名称:丽娜·托雷斯(Lina Torres)的安吉拉(Angela Guette) 项目名称: RubyGems.org采用中心 网址: : 关于该项目: ...
帮助管理和支持 RubyGems.org 的快速命令。 目前帮助通过 SSH 连接到 RubyGems.org 基础设施和运行命令。 安装 $ cd $ git clone git://github.com/rubygems/meg.git .meg 对于 bash 用户: $ echo 'eval "$($...
标题“2.4-3.0.rubygems.rar”暗示了这个压缩包可能包含了Ruby Gems从版本2.4到3.0之间的升级或集合,这对于Ruby开发者来说是一个重要的资源,因为版本升级通常会带来性能优化、新功能以及对旧问题的修复。...
RubyGems.org(姓氏 Gemcutter) Ruby 社区的 Gem 托管。目的提供更好的 API 来处理 gems 创建更透明和可访问的项目页面使社区能够改进和增强站点链接 :#rubygems 在 Freenode 上: : :贡献请遵循我们的。 要进行...
Download from: rubygems.org/pages/download Unpack into a directory and cd there Install with: ruby setup.rb # you may need admin/root privilege For more details and other options, see: ruby setup....
为了在Ruby环境中使用这个gem,你需要先安装Ruby和RubyGems,然后可以通过命令`gem install redis-3.2.2.gem`来安装Redis。安装完成后,你可以使用Redis的命令行客户端redis-cli进行连接和操作,或者通过Ruby的Redis...
`.gem`文件是RubyGems的包格式,用于分发和安装Ruby库,包括Redis的客户端库或与Redis相关的工具。 4. **redis-config**: 提到的"6个redis-config配置文件"可能是指Redis服务器的配置文件,它们通常用于设置Redis...
在这个场景中,我们关注的是Redis的集群搭建,涉及到的文件是"redis-3.0.0.tar"和"redis-3.0.0.gem"。这两个文件分别对应Redis服务本身和通过Ruby来创建Redis集群的工具。 首先,`redis-3.0.0.tar`是一个源代码...
5. **命令行工具**:RubyGems提供了一系列的命令行工具,如`gem install`用于安装gem,`gem update`用于更新gem,`gem list`用于查看已安装的gem等。 在RubyGems 3.2.27版本中,可能包括以下改进和更新: - **性能...
rubygems-update-1.3.1.gem
https://rubygems.org/pages/download http://rubyinstaller.org/downloads/ 1.默认路径安装ruby186-26.exe 2.本地安装watir-1.4.1.gem,执行gem install watir-1.4.1.gem -l 3.本地安装rubygems-update-1.3.4.gem,...
本安装包包含两个关键文件:`redis-3.2.1.gem` 和 `rubygems-2.4.2.zip`,它们都是为了在离线环境下搭建Redis集群而准备的。 首先,`redis-3.2.1.gem` 是Redis的Ruby gem包,适用于使用Ruby语言进行部署和管理Redis...
rubygems-update-1.3.7.gem
Rubygems.org S3 存储桶中的 .gem 文件验证本地 .gem 文件来帮助我们。 此过程是可选的,但它有助于我们重建对 Rubygems.org 的信任,因此我们感谢您做出的任何贡献。 在开始之前,请注意有两种方法可以完成此操作