ruby-on-rails - 新手询问 gem 结构的建议

Question

我计划编写一个 gem，通过从链接下载或从文件系统或字符串获取并上传到 s3 来创建 zip 文件。我从 ruby​​zip 劫持 Zip 模块是个好主意吗？

Zip::Voidzip.upload! do |zip|
  zip.add "http://example.com/example.png", :as => "image/zzz.png"
  zip.add "asdasdasdads"
  zip.add "asd/asd.png"
end

因为代码很可能是这样的。

module Zip
  class Voidzip
    def initialize zipname
      t = Tempfile.new(zipname)
      ZipOutputStream.open(t.path) do |zos|

      end
    end
  end
end

对想要贡献的新手有什么建议吗？

Answer 1

最佳做法是将您的 gem 命名为 voidzip。

如果您打算让您的 gem 成为 zip 的插件，并且如果 zip 实际上支持插件架构，那么实践将是将您的 gem 命名为 zip-voidzip(但我认为这里不是这种情况)。

您的模块/命名空间结构应该反射(reflect)您的 gem 的名称。

如果您的 gem 名为 voidzip，那么我希望您的所有代码都在 Voidzip 中，并且我希望能够要求“voidzip”.

如果你的 gem 被命名为 zip-voidzip，那么我希望你所有的代码都在 Zip::Voidzip 中并且我希望能够 require "zip-voidzip" 或 require "zip/voidzip" 由我选择。