nesquena/gitdocs

View on GitHub
test/integration/test_helper.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Module has too many lines. [136/100]
Open

module Helper
  include MiniTest::Aruba
  include Capybara::DSL
  include Capybara::RSpecMatchers

Severity: Minor
Found in test/integration/test_helper.rb by rubocop

This cop checks if the length a module exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Assignment Branch Condition size for after_teardown is too high. [34.77/15]
Open

  def after_teardown
    restore_env
    processes.clear

    if File.exist?(PID_FILE)
Severity: Minor
Found in test/integration/test_helper.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Assignment Branch Condition size for before_setup is too high. [24.27/15]
Open

  def before_setup
    clean_current_directory

    # HACK: In order to ensure that rugged/libgit2 see the expected HOME
    # directory we must set it before requiring rugged. This seems to occur
Severity: Minor
Found in test/integration/test_helper.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Cyclomatic complexity for after_teardown is too high. [8/6]
Open

  def after_teardown
    restore_env
    processes.clear

    if File.exist?(PID_FILE)
Severity: Minor
Found in test/integration/test_helper.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Perceived complexity for after_teardown is too high. [8/7]
Open

  def after_teardown
    restore_env
    processes.clear

    if File.exist?(PID_FILE)
Severity: Minor
Found in test/integration/test_helper.rb by rubocop

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Method after_teardown has 33 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def after_teardown
    restore_env
    processes.clear

    if File.exist?(PID_FILE)
Severity: Minor
Found in test/integration/test_helper.rb - About 1 hr to fix

    Method after_teardown has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

      def after_teardown
        restore_env
        processes.clear
    
        if File.exist?(PID_FILE)
    Severity: Minor
    Found in test/integration/test_helper.rb - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Use meaningful heredoc delimiters.
    Open

          EOS
    Severity: Minor
    Found in test/integration/test_helper.rb by rubocop

    This cop checks that your heredocs are using meaningful delimiters. By default it disallows END and EO*, and can be configured through blacklisting additional delimiters.

    Example:

    # good
    <<-SQL
      SELECT * FROM foo
    SQL
    
    # bad
    <<-END
      SELECT * FROM foo
    END
    
    # bad
    <<-EOS
      SELECT * FROM foo
    EOS

    Unnecessary utf-8 encoding comment.
    Open

    # -*- encoding : utf-8 -*-
    Severity: Minor
    Found in test/integration/test_helper.rb by rubocop

    Favor a normal if-statement over a modifier clause in a multiline statement.
    Open

        refute(
          File.read(log_filename).include?('ERROR'), 'Unexpected ERROR in log'
        ) if File.exist?(log_filename)
    Severity: Minor
    Found in test/integration/test_helper.rb by rubocop

    Checks for uses of if/unless modifiers with multiple-lines bodies.

    Example:

    # bad
    {
      result: 'this should not happen'
    } unless cond
    
    # good
    { result: 'ok' } if cond

    When using method_missing, define respond_to_missing? and fall back on super.
    Open

        def method_missing(method, *args, &block)
          aruba.send(method, *args, &block)
        end
    Severity: Minor
    Found in test/integration/test_helper.rb by rubocop

    This cop checks for the presence of method_missing without also defining respond_to_missing? and falling back on super.

    Example:

    #bad
    def method_missing(name, *args)
      # ...
    end
    
    #good
    def respond_to_missing?(name, include_private)
      # ...
    end
    
    def method_missing(name, *args)
      # ...
      super
    end

    There are no issues that match your filters.

    Category
    Status