zammad/zammad

View on GitHub
lib/notification_factory/renderer.rb

Summary

Maintainability
C
1 day
Test Coverage

Method d has a Cognitive Complexity of 48 (exceeds 5 allowed). Consider refactoring.
Open

  def d(key, escape = nil, escaping: true)

    # do validation, ignore some methods
    return "\#{#{key} / not allowed}" if !data_key_valid?(key)

Severity: Minor
Found in lib/notification_factory/renderer.rb - About 7 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 d has 94 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def d(key, escape = nil, escaping: true)

    # do validation, ignore some methods
    return "\#{#{key} / not allowed}" if !data_key_valid?(key)

Severity: Major
Found in lib/notification_factory/renderer.rb - About 3 hrs to fix

    Method escaping has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

      def escaping(key, escape)
        return escaping(key['value'], escape) if key.is_a?(Hash) && key.key?('value')
        return escaping(key.join(', '), escape) if key.respond_to?(:join)
        return key if escape == false
        return key if escape.nil? && !@escape && !@url_encode
    Severity: Minor
    Found in lib/notification_factory/renderer.rb - About 45 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

    Avoid too many return statements within this method.
    Open

        return placeholder if !escaping
    Severity: Major
    Found in lib/notification_factory/renderer.rb - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

          return ERB::Util.url_encode(key) if @url_encode
      Severity: Major
      Found in lib/notification_factory/renderer.rb - About 30 mins to fix

        There are no issues that match your filters.

        Category
        Status