enkessler/cuke_linter

View on GitHub
lib/cuke_linter/linters/test_with_setup_step_after_action_step_linter.rb

Summary

Maintainability
A
2 hrs
Test Coverage
module CukeLinter

  # A linter that detects scenarios and outlines that have a setup step that comes after an action step
  class TestWithSetupStepAfterActionStepLinter < Linter

    # Changes the linting settings on the linter using the provided configuration
    def configure(options)
      @given_keywords = options['Given']
      @when_keywords  = options['When']
    end

    # The rule used to determine if a model has a problem
    def rule(model)
      return false unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)

      model_steps       = model.steps || []
      action_step_found = false

      model_steps.each do |step|
        if action_step_found
          return true if given_keywords.include?(step.keyword)
        else
          action_step_found = when_keywords.include?(step.keyword)
        end
      end

      false
    end

    # The message used to describe the problem that has been found
    def message
      "Test has 'Given' step after 'When' step."
    end

    private

    def given_keywords
      @given_keywords || [DEFAULT_GIVEN_KEYWORD]
    end

    def when_keywords
      @when_keywords || [DEFAULT_WHEN_KEYWORD]
    end

  end
end