Sign upLogin

newtheatre/history-project

View on GitHub
Star
_plugins/year.rb

Summary

Maintainability
A
45 mins
Test Coverage

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

    def generate(site)
      if not site.config["skip_years"]
        @collection = site.collections["years"]
        Jekyll.logger.info "Generating years..."
Severity: Minor
Found in _plugins/year.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

Redundant use of Object#to_s in interpolation.
Open

      "#{ @year.to_s } – #{ year_span_short[1] }"
Severity: Minor
Found in _plugins/year.rb by rubocop

This cop checks for string conversion in string interpolation, which is redundant.

Example:

# bad

"result is #{something.to_s}"

Example:

# good

"result is #{something}"

Literal """Return the two character representation of the year span as a list""" used in void context.
Open

      """Return the two character representation of the year span as a list"""
Severity: Minor
Found in _plugins/year.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

Useless assignment to variable - committees.
Open

      committees = @site.collections["committees"].docs
Severity: Minor
Found in _plugins/year.rb by rubocop

This cop checks for every useless assignment to local variable in every scope. The basic idea for this cop was from the warning of ruby -cw:

assigned but unused variable - foo

Currently this cop has advanced logic that detects unreferenced reassignments and properly handles varied cases such as branch, loop, rescue, ensure, etc.

Example:

# bad

def some_method
  some_var = 1
  do_something
end

Example:

# good

def some_method
  some_var = 1
  do_something(some_var)
end

Useless assignment to variable - top_show_count.
Open

      top_show_count = 0
Severity: Minor
Found in _plugins/year.rb by rubocop

This cop checks for every useless assignment to local variable in every scope. The basic idea for this cop was from the warning of ruby -cw:

assigned but unused variable - foo

Currently this cop has advanced logic that detects unreferenced reassignments and properly handles varied cases such as branch, loop, rescue, ensure, etc.

Example:

# bad

def some_method
  some_var = 1
  do_something
end

Example:

# good

def some_method
  some_var = 1
  do_something(some_var)
end

Literal """Method called for every year""" used in void context.
Open

      """Method called for every year"""
Severity: Minor
Found in _plugins/year.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

Redundant use of Object#to_s in interpolation.
Open

      "#{ @year.to_s }–#{ year_span_short[1] }"
Severity: Minor
Found in _plugins/year.rb by rubocop

This cop checks for string conversion in string interpolation, which is redundant.

Example:

# bad

"result is #{something.to_s}"

Example:

# good

"result is #{something}"

Unused method argument - index. If it's necessary, use _ or _index as an argument name to indicate that it won't be used.
Open

    def generate_year(year, index)
Severity: Minor
Found in _plugins/year.rb by rubocop

This cop checks for unused method arguments.

Example:

# bad

def some_method(used, unused, _unused_but_allowed)
  puts used
end

Example:

# good

def some_method(used, _unused, _unused_but_allowed)
  puts used
end

There are no issues that match your filters.

Category
Status