nabeelamjad/poke-api

View on GitHub
lib/poke-api/geometry/s2_cell_id.rb

Summary

Maintainability
A
1 hr
Test Coverage

Cyclomatic complexity for level is too high. [7/6]
Open

        def level
          return MAX_LEVEL if leaf?

          x = (@id & 0xffffffff)
          level = -1
Severity: Minor
Found in lib/poke-api/geometry/s2_cell_id.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.

Cyclomatic complexity for valid_face_xyz_to_uv is too high. [7/6]
Open

        def self.valid_face_xyz_to_uv(face, p)
          raise unless p.dot_prod(face_uv_to_xyz(face, 0, 0)) > 0

          case face
          when 0 then [p.y / p.x, p.z / p.x]
Severity: Minor
Found in lib/poke-api/geometry/s2_cell_id.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 level has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

        def level
          return MAX_LEVEL if leaf?

          x = (@id & 0xffffffff)
          level = -1
Severity: Minor
Found in lib/poke-api/geometry/s2_cell_id.rb - About 1 hr 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 pface.negative? instead of pface < 0.
Open

          face += 3 if pface < 0
Severity: Minor
Found in lib/poke-api/geometry/s2_cell_id.rb by rubocop

This cop checks for usage of comparison operators (==, >, <) to test numbers as zero, positive, or negative. These can be replaced by their respective predicate methods. The cop can also be configured to do the reverse.

The cop disregards #nonzero? as it its value is truthy or falsey, but not true and false, and thus not always interchangeable with != 0.

The cop ignores comparisons to global variables, since they are often populated with objects which can be compared with integers, but are not themselves Interger polymorphic.

Example: EnforcedStyle: predicate (default)

# bad

foo == 0
0 > foo
bar.baz > 0

# good

foo.zero?
foo.negative?
bar.baz.positive?

Example: EnforcedStyle: comparison

# bad

foo.zero?
foo.negative?
bar.baz.positive?

# good

foo == 0
0 > foo
bar.baz > 0

Use p.dot_prod(face_uv_to_xyz(face, 0, 0)).positive? instead of p.dot_prod(face_uv_to_xyz(face, 0, 0)) > 0.
Open

          raise unless p.dot_prod(face_uv_to_xyz(face, 0, 0)) > 0
Severity: Minor
Found in lib/poke-api/geometry/s2_cell_id.rb by rubocop

This cop checks for usage of comparison operators (==, >, <) to test numbers as zero, positive, or negative. These can be replaced by their respective predicate methods. The cop can also be configured to do the reverse.

The cop disregards #nonzero? as it its value is truthy or falsey, but not true and false, and thus not always interchangeable with != 0.

The cop ignores comparisons to global variables, since they are often populated with objects which can be compared with integers, but are not themselves Interger polymorphic.

Example: EnforcedStyle: predicate (default)

# bad

foo == 0
0 > foo
bar.baz > 0

# good

foo.zero?
foo.negative?
bar.baz.positive?

Example: EnforcedStyle: comparison

# bad

foo.zero?
foo.negative?
bar.baz.positive?

# good

foo == 0
0 > foo
bar.baz > 0

There are no issues that match your filters.

Category
Status