Gotchas para escribir rubygems

Question

Ha habido preguntas con respuestas en how a write rubygems, pero ¿qué debe evitar al escribir un rubygem? ¿Qué puede causar problemas para las personas que usan su rubygem?

Answer 1

Gem Packaging: Best Practices da un montón de consejos, algunos de los cuales incluyen

• no contaminan el camino de carga global. Idealmente, solo tiene foo.rb en su directorio lib, y ponga todos sus otros archivos en lib/foo.

• No require archivos usando __FILE__.

• No confíe en nada fuera de la ruta de carga. Las carpetas pueden no tener la misma estructura que en su versión original. Por ejemplo, no use algo como

  VERSION = :: File.read (:: File.join (:: File.dirname (FILE), "..", "..", "VERSION ")). strip

• No administrar $LOAD_PATH dentro de lib.

• Proporcione una constante VERSION.

• No dependa de rubygems. La persona que usa su código puede no estar usando rubygems, sino algún otro sistema de empaque (o ningún sistema de empaque). Del mismo modo, no mencione las dependencias de versión en el código en sí, o rescue Gem::LoadError.

Rubygems dependencies. Please... sostiene que no se deben listar las dependencias de tiempo de ejecución opcional, y debe separar desarrollador de dependencias en tiempo de ejecución.

From my own experience: si nada más, intente construir e instalar su gema localmente antes de liberarla en libertad. Evita las liberaciones de bolsas de papel marrón.