rapid7/metasploit-framework

View on GitHub
tools/dev/find_release_notes.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Method add_release_notes_entry has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    def add_release_notes_entry(row)
      td = row.search('td')
      release_notes_link = td[0] && td[0].at('a') ? td[0].at('a').attributes['href'].value : ''
      release_notes_num = td[0] && td[0].at('a') ? td[0].at('a').text.scan(/\d{10}/).flatten.first || '' : ''
      highlights = td[1] ? (td[1].search('span') || []).map { |e| e.text } * " " : ''
Severity: Minor
Found in tools/dev/find_release_notes.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

Method main has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

def main
  inputs = []

  ARGV.length.times { inputs << ARGV.shift }
  puts "[*] Enumerating release notes..."
Severity: Minor
Found in tools/dev/find_release_notes.rb - About 1 hr to fix

    Method get_release_notes has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_release_notes(input)
          release_notes.each do |n|
            if n[:pull_requests].empty?
              update_release_notes_entry(n)
            end
    Severity: Minor
    Found in tools/dev/find_release_notes.rb - About 25 mins 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

    There are no issues that match your filters.

    Category
    Status