Sign upLogin

grokify/ringcentral-sdk-ruby

View on GitHub
Star
lib/ringcentral_sdk/rest/event.rb

Summary

Maintainability
A
1 hr
Test Coverage

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

      def new_type_count(type)
        count = 0
        have_type = false
        changes = @doc.getAttr('body.changes')
        if changes.is_a?(Array) && !changes.empty?
Severity: Minor
Found in lib/ringcentral_sdk/rest/event.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 new_type_count has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

      def new_type_count(type)
        count = 0
        have_type = false
        changes = @doc.getAttr('body.changes')
        if changes.is_a?(Array) && !changes.empty?
Severity: Minor
Found in lib/ringcentral_sdk/rest/event.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 each_key instead of each.
Open

        hash.each do |k, _|
Severity: Minor
Found in lib/ringcentral_sdk/rest/event.rb by rubocop

This cop checks for uses of each_key and each_value Hash methods.

Note: If you have an array of two-element arrays, you can put parentheses around the block arguments to indicate that you're not working with a hash, and suppress RuboCop offenses.

Example:

# bad
hash.keys.each { |k| p k }
hash.values.each { |v| p v }
hash.each { |k, _v| p k }
hash.each { |_k, v| p v }

# good
hash.each_key { |k| p k }
hash.each_value { |v| p v }

Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
Open

        if _hash_has_string_keys hash
Severity: Minor
Found in lib/ringcentral_sdk/rest/event.rb by rubocop

Checks for if and unless statements that would fit on one line if written as a modifier if/unless. The maximum line length is configured in the Metrics/LineLength cop.

Example:

# bad
if condition
  do_stuff(bar)
end

unless qux.empty?
  Foo.do_something
end

# good
do_stuff(bar) if condition
Foo.do_something unless qux.empty?

There are no issues that match your filters.

Category
Status