ruby - 我应该把我的 gem 放在我开发的 gem 中的什么地方？

Question

我正在尝试了解 gem 应该放在哪里。我写了一个 ruby​​ 脚本，我想把它转换成一个 gem。我使用 bundler 为我的 gem 创建了骨架。

现在我得到了 2 个文件“Gemfile”和“mygem.gemspec”。

在我的 Gemfile 中有两行内容:

source 'https://rubygems.org'

# Specify your gem's dependencies in cudruby.gemspec
gemspec

..在我的“mygem.gemspec”中我得到了:

# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'mygem/version'

Gem::Specification.new do |spec|
  spec.name          = "mygem"
  spec.version       = Mygem::VERSION
  spec.authors       = ["mygem"]
  spec.email         = ["mygem@gmail.com"]
  spec.summary       = %q{mygem}
  spec.description   = %q{mygem}
  spec.homepage      = "http://www.mygem.com"
  spec.license       = "MIT"

  spec.files         = Dir["{lib}/**/*.rb", "bin/*", "LICENSE", "*.md"]
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

  spec.add_development_dependency "bundler", "~> 1.6"
  spec.add_development_dependency "rake"
end

现在我的 ruby​​ 脚本过去依赖于 3 个 gem，“facter”、“debugger”、“json”。

我在哪里添加这些？以及如何？

我发现了这个: http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/

现在那个人说(来自链接):

“在开发 gem 时，请在 Gemfile 中使用 gemspec 方法以避免重复。一般来说，gem 的 Gemfile 应包含 Rubygems 源代码和单个 gemspec 行...”

所以我保留了原样的 gemspec 文件..

我查看了 facter 的官方仓库，它的 Gemfile 是: https://github.com/puppetlabs/facter/blob/master/Gemfile

..他的 gemspec 是: https://github.com/puppetlabs/facter/blob/master/.gemspec

现在为什么他在 Gemfile 中有他的 gem ，而在 gemspec 中什么都没有？他所做的与我读到的完全相反。

有人可以帮我说清楚吗？

谢谢!

Answer 1

一个重要的细节是 Gemfile 和 mygem.gemspec 是 Ruby 文件。这意味着你有很大的灵 active ，并且可以使事情以许多不同的方式工作，前提是 bundle 和 gem 获得他们需要的数据。但是，值得遵循最近文档中的标准示例，代码通常更清晰且更易于理解。

Gemfile 中的方法 gemspec 是一种告诉 Bundler“这个项目使用在 gemspec 中定义的 gem 列表”的便捷方式 - 也就是说，它避免了你需要两次列出依赖项 - 启用 bundle install 并允许 gem 自动安装其依赖项。

在哪里添加依赖项？ 在 gemspec 的末尾，像这样:

  spec.add_development_dependency "rake"

  # Example of one of your dependencies
  spec.add_dependency "facter", ">= 2.3.0"
end

理想情况下，您应该引用您确信可以与您的 gem 一起正常工作的最低版本。

您不应该使用 facter gem 作为模板或示例，那里有一些非标准的东西。首先，您链接的 .gemspec 不是用于构建 gem 的 facter 的 gemspec。至少部分原因在于这颗 gem 的悠久历史，已有将近 10 年的历史。最初编写时，bundler 和 gem 的工具包与现在完全不同。

---

这不是直接询问的，但值得注意的是完整性:

依赖项列表用于 Bundler(在 Gemfile 中)和 gem 构建/安装(在 .gemspec 中)。它们不会自动在您的代码中包含依赖项 gem。因此，您还需要像以前一样将 require 语句添加到您的 ruby​​ 源代码中。