Sign upLogin

newtheatre/history-project

View on GitHub
Star
_plugins/person_list.rb

Summary

Maintainability
B
4 hrs
Test Coverage

Method fill_people_reverse_index has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

def fill_people_reverse_index(item, people_list, index_name, site)

  # Create the RI for this case if first time
  unless site.data.key?(index_name)
    site.data[index_name] = Hash.new
Severity: Minor
Found in _plugins/person_list.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 fill_people_reverse_index is too high. [10/6]
Open

def fill_people_reverse_index(item, people_list, index_name, site)

  # Create the RI for this case if first time
  unless site.data.key?(index_name)
    site.data[index_name] = Hash.new
Severity: Minor
Found in _plugins/person_list.rb by rubocop

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.

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

def fill_people_reverse_index(item, people_list, index_name, site)

  # Create the RI for this case if first time
  unless site.data.key?(index_name)
    site.data[index_name] = Hash.new
Severity: Minor
Found in _plugins/person_list.rb - About 1 hr to fix

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

def parse_person_list(pl, people_by_filename)
  """Add additional data to a person_list"""
  for pli in pl
    if pli.key?("name")
      filename = make_hp_path(pli["name"])
Severity: Minor
Found in _plugins/person_list.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

Use tr instead of gsub.
Open

  title.downcase.gsub(/[^0-9a-z \-]/i, '').gsub(' ','_')
Severity: Minor
Found in _plugins/person_list.rb by rubocop

This cop identifies places where gsub can be replaced by tr or delete.

Example:

# bad
'abc'.gsub('b', 'd')
'abc'.gsub('a', '')
'abc'.gsub(/a/, 'd')
'abc'.gsub!('a', 'd')

# good
'abc'.gsub(/.*/, 'a')
'abc'.gsub(/a+/, 'd')
'abc'.tr('b', 'd')
'a b c'.delete(' ')

Literal """Add additional data to a person_list""" used in void context.
Open

  """Add additional data to a person_list"""
Severity: Minor
Found in _plugins/person_list.rb by rubocop

This cop checks for operators, variables and literals used in void context.

Example:

# bad

def some_method
  some_num * 10
  do_something
end

Example:

# bad

def some_method(some_var)
  some_var
  do_something
end

Example:

# good

def some_method
  do_something
  some_num * 10
end

Example:

# good

def some_method(some_var)
  do_something
  some_var
end

There are no issues that match your filters.

Category
Status