Ruby Language Support

Summary

Details

File extensions

By default, Ruby files are defined as:

[file_types.ruby]
globs = [
  "*.rb",
  "*.rake",
  "**/.irbrc",
  "**/.pryrc",
  "**/Appraisals",
  "**/Berksfile",
  "**/Brewfile",
  "**/buildfile",
  "**/Buildfile",
  "**/Capfile",
  "**/Dangerfile",
  "**/Deliverfile",
  "**/Fastfile",
  "**/Gemfile",
  "**/Guardfile",
  "**/Jarfile",
  "**/Mavenfile",
  "**/Podfile",
  "**/Puppetfile",
  "**/Rakefile",
  "**/Snapfile",
  "**/Thorfile",
  "**/Vagrantfile",
]
interpreters = ["jruby", "rbx", "rake", "macruby", "ruby"]

These patterns can be overridden from qlty.toml.

Code coverage setup

QLTY supports code coverage for Ruby through SimpleCov. For a full working example, see our example Ruby repository.

SimpleCov configuration

To instrument test coverage with SimpleCov:

1. Install SimpleCov:

1
gem install simplecov

2. Configure SimpleCov to generate JSON reports:

1
require 'simplecov'
2
require 'simplecov_json_formatter'
3
SimpleCov.start do
4
    formatter SimpleCov::Formatter::JSONFormatter
5
    add_filter '/spec/'
6
end

If you want to combine the JSON format with other formats, use SimpleCov’s MultiFormatter:

1
SimpleCov.start do
2
    formatter SimpleCov::Formatter::MultiFormatter.new([
3
      SimpleCov::Formatter::JSONFormatter,
4
      SimpleCov::Formatter::HTMLFormatter
5
    ])
6
    add_filter '/spec/'
7
end

3. Publish SimpleCov’s JSON coverage reports using qlty coverage publish:

1
qlty coverage publish coverage/coverage.json

For GitHub Actions users, you can use our example workflow.

Supported Ruby versions

We officially support Ruby 2.5 and later for maintainability checks and code coverage. SimpleCov version 0.22.0+ is recommended for code coverage. Each plugin may have its own version requirements.