Sign upLogin

stevenhallen/document_generator

View on GitHub
Star

Showing 5 of 5 total issues

Method markdown_outputs_for has 39 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def markdown_outputs_for(hunk) # returns an array of outputs for a particular hunk
      outputs = []
      last_line = -1
      git_diff_lines_for(hunk).each_with_index do |line, index|
        next if index <= last_line
Severity: Minor
Found in lib/document_generator/diff_file.rb - About 1 hr to fix

    Method content has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

        def content
      if type == 'deleted'
        return "####{patch_heading}\n\n"
      end
    Severity: Minor
    Found in lib/document_generator/diff_file.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 markdown_outputs_for has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

        def markdown_outputs_for(hunk) # returns an array of outputs for a particular hunk
      outputs = []
      last_line = -1
      git_diff_lines_for(hunk).each_with_index do |line, index|
        next if index <= last_line
    Severity: Minor
    Found in lib/document_generator/diff_file.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 initialize has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def initialize(base_url, git_commit, account_name, repo, access_token)
    Severity: Minor
    Found in lib/document_generator/commit.rb - About 35 mins to fix

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

          def ending_code_for(hunk)
      clean_lines = []

      git_diff_lines_for(hunk).each_with_index do |line, index|
        if (line[0]) == "-" || ignore_line?(line)
      Severity: Minor
      Found in lib/document_generator/diff_file.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

      Severity
      Category
      Status
      Source
      Language