Question

I plan to write a gem that create a zip file by download from a link or get from filesystem or from a string and upload to s3. Is it a good idea I hijack the Zip module from rubyzip?

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

Since the code most probabily will be like this.

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

      end
    end
  end
end

Any suggestion for newbie that want to contribute?

Answer 1

Best practice is to name your gem voidzip.

If you are intending your gem to be a plugin for zip, and if zip actually supports a plugin architecture, then practice would be to name your gem zip-voidzip (but I don’t think that’s the case here).

Your module/namespace structure should mirror your gem’s name.

If your gem is named voidzip, then I expect all of your code to be within Voidzip and I expect to be able to require "voidzip".

If your gem is named zip-voidzip, then I expect all of your code to be within Zip::Voidzip and I expect to be able to require "zip-voidzip" or require "zip/voidzip" at my choice.