Class: CukeLinter::TestWithTooManyStepsLinter

Inherits:
Linter
  • Object
show all
Defined in:
lib/cuke_linter/linters/test_with_too_many_steps_linter.rb

Overview

A linter that detects scenarios and outlines that have too many steps

Instance Attribute Summary

Attributes inherited from Linter

#name

Instance Method Summary collapse

Methods inherited from Linter

#initialize, #lint

Constructor Details

This class inherits a constructor from CukeLinter::Linter

Instance Method Details

#configure(options) ⇒ Object

Changes the linting settings on the linter using the provided configuration



7
8
9
# File 'lib/cuke_linter/linters/test_with_too_many_steps_linter.rb', line 7

def configure(options)
  @step_threshold = options['StepThreshold'] if options['StepThreshold']
end

#messageObject

The message used to describe the problem that has been found



22
23
24
# File 'lib/cuke_linter/linters/test_with_too_many_steps_linter.rb', line 22

def message
  "Test has too many steps. #{@linted_step_count} steps found (max #{@linted_step_threshold})."
end

#rule(model) ⇒ Object

The rule used to determine if a model has a problem



12
13
14
15
16
17
18
19
# File 'lib/cuke_linter/linters/test_with_too_many_steps_linter.rb', line 12

def rule(model)
  return false unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)

  @linted_step_count     = model.steps.nil? ? 0 : model.steps.count
  @linted_step_threshold = @step_threshold || 10

  @linted_step_count > @linted_step_threshold
end