expertiza/expertiza

View on GitHub
app/models/view_translation_substitutor.rb

Summary

Maintainability
A
4 hrs
Test Coverage
F
0%

Assignment Branch Condition size for process_translation is too high. [37.96/15]
Open

  def process_translation(contents, key, val)
    replacements = []
    skips = []
    resume_index = 0
    while resume_index < contents.length

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

Method has too many lines. [29/10]
Open

  def process_translation(contents, key, val)
    replacements = []
    skips = []
    resume_index = 0
    while resume_index < contents.length

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

Method process_translation has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

  def process_translation(contents, key, val)
    replacements = []
    skips = []
    resume_index = 0
    while resume_index < contents.length
Severity: Minor
Found in app/models/view_translation_substitutor.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

Cyclomatic complexity for process_translation is too high. [10/6]
Open

  def process_translation(contents, key, val)
    replacements = []
    skips = []
    resume_index = 0
    while resume_index < contents.length

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 process_translation is too high. [11/7]
Open

  def process_translation(contents, key, val)
    replacements = []
    skips = []
    resume_index = 0
    while resume_index < contents.length

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 has too many lines. [12/10]
Open

  def process_view(directory_name, view_name, translations)
    path = "./#{directory_name}/#{view_name}.html.erb"
    unless File.exist?(path)
      path = "./#{directory_name}/_#{view_name}.html.erb"
      return '<file not found>' unless File.exist?(path)

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

Method process_translation has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def process_translation(contents, key, val)
    replacements = []
    skips = []
    resume_index = 0
    while resume_index < contents.length
Severity: Minor
Found in app/models/view_translation_substitutor.rb - About 1 hr to fix

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

      def process_view(directory_name, view_name, translations)
        path = "./#{directory_name}/#{view_name}.html.erb"
        unless File.exist?(path)
          path = "./#{directory_name}/_#{view_name}.html.erb"
          return '<file not found>' unless File.exist?(path)
    Severity: Minor
    Found in app/models/view_translation_substitutor.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

    Missing top-level class documentation comment.
    Open

    class ViewTranslationSubstitutor

    This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

    The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

    Example:

    # bad
    class Person
      # ...
    end
    
    # good
    # Description/Explanation of Person class
    class Person
      # ...
    end

    There are no issues that match your filters.

    Category
    Status