Ruby

Configuration - .deepsource.toml

This section covers configuration specific to the ruby analyzer. Please make sure you read the general configuration guide first.

name

• Type: String
• Presence: mandatory
• Description: Shortcode of the analyzer.
• Example:

name = "ruby"

enabled

• Type: Boolean
• Presence: optional
• Description: Toggle whether this analyzer should be run.
• Example:

enabled = true

meta

• Type: Table
• Presence: optional
• Description: Any supported metadata to pass to the analyzer.
• Example:

[analyzers.meta]
	skip_doc_coverage = ["module", "class"]

skip_doc_coverage

• Type: Array

• Presence: optional

• Description: Specify which artifacts to skip when calculating documentation coverage.

• Available Values: class, module, method, singleton_method

• class - Ignore documentation coverage for class definitions

• module - Ignore documentation coverage for module definitions

• method - Ignore documentation coverage for method definitions

• singleton_method - Ignore documentation coverage for singleton method definitions

• Default Value: []

• Example:

skip_doc_coverage = ["module", "singleton_method"]

cyclomatic_complexity_threshold

• Type: String

• Presence: optional

• Description: Specify the acceptable risk category for your project as the threshold. All functions with complexity beyond this threshold will raise an issue. For example, setting the threshold to low will flag all functions that have a cyclomatic complexity of more than 5, while setting the threshold to critical will not flag any function.

• Available Values: low, medium, high, very-high and critical

• Default Value: medium
• Example:

[analyzers.meta]
cyclomatic_complexity_threshold = "high"

Sample config

version = 1

test_patterns = [
  "test/**",
  "*_test.rb"
]

exclude_patterns = [
  "vendor/**",
  "**/examples/**"
]

[[analyzers]]
name = "ruby"
enabled = true

  [analyzers.meta]
  skip_doc_coverage = ["module", "singleton_method"]

📘

We currently support Ruby 2.0 and above.