Sign upLogin

ruby/rdoc

View on GitHub
Star
lib/rdoc/parser.rb

Summary

Maintainability
B
6 hrs
Test Coverage

Method for has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

  def self.for top_level, file_name, content, options, stats
    return if binary? file_name

    parser = use_markup content
Severity: Minor
Found in lib/rdoc/parser.rb - About 2 hrs 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 can_parse_by_name has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

  def self.can_parse_by_name file_name
    _, parser = RDoc::Parser.parsers.find { |regexp,| regexp =~ file_name }

    # The default parser must not parse binary files
    ext_name = File.extname file_name
Severity: Minor
Found in lib/rdoc/parser.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 check_modeline has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

  def self.check_modeline file_name
    line = File.open file_name do |io|
      io.gets
    end
Severity: Minor
Found in lib/rdoc/parser.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 top_level, file_name, content, options, stats
Severity: Minor
Found in lib/rdoc/parser.rb - About 35 mins to fix

    Method for has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

      def self.for top_level, file_name, content, options, stats
    Severity: Minor
    Found in lib/rdoc/parser.rb - About 35 mins to fix

      There are no issues that match your filters.

      Category
      Status