Sign upLogin

ringcentral-ruby/glip-sdk-ruby

View on GitHub
Star

Showing 44 of 44 total issues

Assignment Branch Condition size for post is too high. [32.34/15]
Open

      def post(opts = {})
        unless opts.key? :text
          raise ArgumentError, "Text must be provided to post message"
        end
Severity: Minor
Found in lib/glip_sdk/rest/posts.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method has too many lines. [23/10]
Open

      def post(opts = {})
        unless opts.key? :text
          raise ArgumentError, "Text must be provided to post message"
        end
Severity: Minor
Found in lib/glip_sdk/rest/posts.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.

Assignment Branch Condition size for all_groups is too high. [22.91/15]
Open

      def all_groups(params = {})
        groups = []
        get_next = true
        while get_next
          res = get params
Severity: Minor
Found in lib/glip_sdk/rest/groups.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method has too many lines. [13/10]
Open

      def all_groups(params = {})
        groups = []
        get_next = true
        while get_next
          res = get params
Severity: Minor
Found in lib/glip_sdk/rest/groups.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.

Cyclomatic complexity for post is too high. [8/6]
Open

      def post(opts = {})
        unless opts.key? :text
          raise ArgumentError, "Text must be provided to post message"
        end
Severity: Minor
Found in lib/glip_sdk/rest/posts.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.

Perceived complexity for post is too high. [9/7]
Open

      def post(opts = {})
        unless opts.key? :text
          raise ArgumentError, "Text must be provided to post message"
        end
Severity: Minor
Found in lib/glip_sdk/rest/posts.rb by rubocop

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Method has too many lines. [11/10]
Open

    def load_group(group)
      if group.key? 'id'
        id = group['id']
        type = group['type']
        if type.to_s.downcase == 'team'
Severity: Minor
Found in lib/glip_sdk/rest/cache/groups.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 post has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

      def post(opts = {})
        unless opts.key? :text
          raise ArgumentError, "Text must be provided to post message"
        end
Severity: Minor
Found in lib/glip_sdk/rest/posts.rb - About 55 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

Method all_groups has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

      def all_groups(params = {})
        groups = []
        get_next = true
        while get_next
          res = get params
Severity: Minor
Found in lib/glip_sdk/rest/groups.rb - About 35 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

Script file groups.rb doesn't have execute permission.
Open

#!ruby
Severity: Minor
Found in scripts/groups.rb by rubocop

Line is too long. [82/80]
Open

        puts ">>>\nGLIP_SCK_LOGGER_NAME [#{@api.config.logger.class.name}]\n<<<\n"
Severity: Minor
Found in lib/glip_sdk/rest/client.rb by rubocop

Line is too long. [98/80]
Open

          @api.config.logger.warn("#{@logger_prefix}Response Body: #{MultiJson.encode(res.body)}")
Severity: Minor
Found in lib/glip_sdk/rest/posts.rb by rubocop

Line is too long. [96/80]
Open

            @api.config.logger.info "PrevPageToken [#{res.body['navigation']['prevPageToken']}]"
Severity: Minor
Found in lib/glip_sdk/rest/groups.rb by rubocop

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

        if opts.key? :postId
Severity: Minor
Found in lib/glip_sdk/rest/posts.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?

Trailing whitespace detected.
Open

          @groups_cache.load_groups @groups.all_groups
Severity: Minor
Found in lib/glip_sdk/rest/client.rb by rubocop

Missing top-level class documentation comment.
Open

    class Client
Severity: Minor
Found in lib/glip_sdk/rest/client.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Use each_value instead of each.
Open

        groups.each { |_, g| load_group g}
Severity: Minor
Found in lib/glip_sdk/rest/cache/groups.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 }

Line is too long. [92/80]
Open

          @api.config.logger.warn("#{@logger_prefix}Glip API Response Status #{res.status}")
Severity: Minor
Found in lib/glip_sdk/rest/posts.rb by rubocop

Line is too long. [83/80]
Open

        @subscription.subscribe ['/restapi/v1.0/account/~/extension/~/glip/groups']
Severity: Minor
Found in lib/glip_sdk/rest/groups.rb by rubocop

Do not use parentheses for method calls with no arguments.
Open

        @subscription = @api.create_subscription()
Severity: Minor
Found in lib/glip_sdk/rest/posts.rb by rubocop

This cop checks for unwanted parentheses in parameterless method calls.

Example:

# bad
object.some_method()

# good
object.some_method
Severity
Category
Status
Source
Language