Sign upLogin

newtheatre/history-project

View on GitHub
Star
_plugins/people_by.rb

Summary

Maintainability
C
1 day
Test Coverage

Method people_iterator has a Cognitive Complexity of 42 (exceeds 5 allowed). Consider refactoring.
Open

    def people_iterator(person)
      if person.data["shows"]
        # If had shows
        for record in person.data["shows"]
          # Loop through each show with involvement
Severity: Minor
Found in _plugins/people_by.rb - About 6 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 people_iterator is too high. [23/6]
Open

    def people_iterator(person)
      if person.data["shows"]
        # If had shows
        for record in person.data["shows"]
          # Loop through each show with involvement
Severity: Minor
Found in _plugins/people_by.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 has too many lines. [37/30]
Open

    def people_iterator(person)
      if person.data["shows"]
        # If had shows
        for record in person.data["shows"]
          # Loop through each show with involvement
Severity: Minor
Found in _plugins/people_by.rb by rubocop

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 people_iterator has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def people_iterator(person)
      if person.data["shows"]
        # If had shows
        for record in person.data["shows"]
          # Loop through each show with involvement
Severity: Minor
Found in _plugins/people_by.rb - About 1 hr to fix

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

    def generate(site)
      Jekyll.logger.info "Generating people by..."

      @year_end = site.config['year_end']
      @role_map = site.data['role-map'].to_liquid
Severity: Minor
Found in _plugins/people_by.rb - About 1 hr to fix

Similar blocks of code found in 2 locations. Consider refactoring.
Open

      if person.data["course"] and person.data["course"].class == Array
        for item in person.data["course"]
          (@people_by_course[item] ||= []) << person
        end
      elsif person.data["course"] and person.data["course"].class == String
Severity: Major
Found in _plugins/people_by.rb and 1 other location - About 1 hr to fix
_plugins/people_by.rb on lines 44..50

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 49.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

      if person.data["careers"] and person.data["careers"].class == Array
        for item in person.data["careers"]
          (@people_by_career[item] ||= []) << person
        end
      elsif person.data["careers"] and person.data["careers"].class == String
Severity: Major
Found in _plugins/people_by.rb and 1 other location - About 1 hr to fix
_plugins/people_by.rb on lines 52..58

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 49.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

There are no issues that match your filters.

Category
Status