cops_packaging.adoc

Packaging

Packaging/BundlerSetupInTests

Enabled by default	Safe	Supports autocorrection	VersionAdded	VersionChanged
Enabled	Yes	No	0.4	-

This cop flags the require "bundler/setup" calls if they’re made from inside the tests directory.

Examples

# bad
require "foo"
require "bundler/setup"

# good
require "foo"

Packaging/GemspecGit

Enabled by default	Safe	Supports autocorrection	VersionAdded	VersionChanged
Enabled	Yes	No	0.1	0.1

This cop flags the usage of git ls-files in gemspec and suggests to use a plain Ruby alternative, like Dir, Dir.glob, or Rake::FileList instead.

More information about the GemspecGit cop can be found here: https://packaging.rubystyle.guide/#gemspec-git

Examples

# bad
Gem::Specification.new do |spec|
  spec.files         = `git ls-files`.split("\n")
  spec.test_files    = `git ls-files -- spec`.split("\n")
end

# good
Gem::Specification.new do |spec|
  spec.files         = Dir["lib/**/*", "LICENSE", "README.md"]
  spec.test_files    = Dir["spec/**/*"]
end

# bad
Gem::Specification.new do |spec|
  spec.files = Dir.chdir(File.expand_path(__dir__)) do
    `git ls-files -z`.split("\\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
  end
end

# good
Gem::Specification.new do |spec|
  spec.files         = Rake::FileList["**/*"].exclude(*File.read(".gitignore").split)
end

# bad
Gem::Specification.new do |spec|
  spec.files         = `git ls-files -- lib/`.split("\n")
  spec.test_files    = `git ls-files -- test/{functional,unit}/*`.split("\n")
  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
end

# good
Gem::Specification.new do |spec|
  spec.files         = Dir.glob("lib/**/*")
  spec.test_files    = Dir.glob("test/{functional,test}/*")
  spec.executables   = Dir.glob("bin/*").map{ |f| File.basename(f) }
end

Packaging/RequireRelativeHardcodingLib

Enabled by default	Safe	Supports autocorrection	VersionAdded	VersionChanged
Enabled	Yes	No	0.2	0.3

This cop flags the require_relative calls, from anywhere mapping to the "lib" directory, except originating from lib/ or the gemspec file, and suggests to use require instead.

More information about the RequireRelativeHardcodingLib cop can be found here: https://packaging.rubystyle.guide/#require-relative-hardcoding-lib

Examples

# bad
require_relative "lib/foo.rb"

# good
require "foo.rb"

# bad
require_relative "../../lib/foo/bar"

# good
require "foo/bar"

# good
require_relative "spec_helper"
require_relative "spec/foo/bar"