Sign upLogin

ringcentral-ruby/lita-glip

View on GitHub
Star

Showing 57 of 57 total issues

Assignment Branch Condition size for update is too high. [40.07/15]
Open

        def update(message)
          m = message

          Lita.logger.debug("#{@logger_prefix}Glip Lita: Glip Message Received: #{MultiJson.encode(m)}")
Severity: Minor
Found in lib/lita/adapters/glip/message_handler.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 update(message)
          m = message

          Lita.logger.debug("#{@logger_prefix}Glip Lita: Glip Message Received: #{MultiJson.encode(m)}")
Severity: Minor
Found in lib/lita/adapters/glip/message_handler.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 create_user is too high. [23.22/15]
Open

          def create_user(user_id, glip_sdk)
            res = glip_sdk.persons.get personId: user_id
            Lita.logger.debug("Glip API Response Status: #{res.status}.")

            if res.status == 200
Severity: Minor
Found in lib/lita/adapters/glip/user_creator.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. [15/10]
Open

          def create_user(user_id, glip_sdk)
            res = glip_sdk.persons.get personId: user_id
            Lita.logger.debug("Glip API Response Status: #{res.status}.")

            if res.status == 200
Severity: Minor
Found in lib/lita/adapters/glip/user_creator.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 update is too high. [10/6]
Open

        def update(message)
          m = message

          Lita.logger.debug("#{@logger_prefix}Glip Lita: Glip Message Received: #{MultiJson.encode(m)}")
Severity: Minor
Found in lib/lita/adapters/glip/message_handler.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. [13/10]
Open

        def initialize(robot, app_key, app_secret, server, username, extension, password, token)
          @robot = robot
          @logger_prefix = " -- #{self.class.name}: "
          @rc_sdk = RingCentralSdk::REST::Client.new do |config|
            config.app_key = app_key
Severity: Minor
Found in lib/lita/adapters/glip/connector.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.

Perceived complexity for update is too high. [10/7]
Open

        def update(message)
          m = message

          Lita.logger.debug("#{@logger_prefix}Glip Lita: Glip Message Received: #{MultiJson.encode(m)}")
Severity: Minor
Found in lib/lita/adapters/glip/message_handler.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

Assignment Branch Condition size for client_connect is too high. [17.29/15]
Open

        def client_connect
          Lita.logger.info("#{@logger_prefix}Authorizing with RingCentral.")
          if @token.nil?
            @rc_sdk.authorize_password @username, @extension, @password
            token = MultiJson.encode @rc_sdk.token.to_hash
Severity: Minor
Found in lib/lita/adapters/glip/connector.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. [12/10]
Open

        def client_connect
          Lita.logger.info("#{@logger_prefix}Authorizing with RingCentral.")
          if @token.nil?
            @rc_sdk.authorize_password @username, @extension, @password
            token = MultiJson.encode @rc_sdk.token.to_hash
Severity: Minor
Found in lib/lita/adapters/glip/connector.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 has too many lines. [11/10]
Open

      def initialize(robot)
        super
        @connector = Connector.new(
          robot,
          config.app_key,
Severity: Minor
Found in lib/lita/adapters/glip.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 initialize is too high. [15.03/15]
Open

      def initialize(robot)
        super
        @connector = Connector.new(
          robot,
          config.app_key,
Severity: Minor
Found in lib/lita/adapters/glip.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 update has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

        def update(message)
          m = message

          Lita.logger.debug("#{@logger_prefix}Glip Lita: Glip Message Received: #{MultiJson.encode(m)}")
Severity: Minor
Found in lib/lita/adapters/glip/message_handler.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

Method initialize has 8 arguments (exceeds 4 allowed). Consider refactoring.
Open

        def initialize(robot, app_key, app_secret, server, username, extension, password, token)
Severity: Major
Found in lib/lita/adapters/glip/connector.rb - About 1 hr to fix

    Avoid parameter lists longer than 5 parameters. [8/5]
    Open

            def initialize(robot, app_key, app_secret, server, username, extension, password, token)
    Severity: Minor
    Found in lib/lita/adapters/glip/connector.rb by rubocop

    This cop checks for methods with too many parameters. The maximum number of parameters is configurable. Keyword arguments can optionally be excluded from the total count.

    The name of this source file (lita-glip.rb) should use snake_case.
    Open

    require 'lita'
    Severity: Minor
    Found in lib/lita-glip.rb by rubocop

    This cop makes sure that Ruby source files have snake_case names. Ruby scripts (i.e. source files with a shebang in the first line) are ignored.

    Example:

    # bad
lib/layoutManager.rb

anything/usingCamelCase

# good
lib/layout_manager.rb

anything/using_snake_case.rake

    Missing top-level class documentation comment.
    Open

          class RoomCreator
    Severity: Minor
    Found in lib/lita/adapters/glip/room_creator.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

    Line is too long. [104/80]
    Open

              Lita.logger.debug("#{@logger_prefix}Glip Lita: Glip Message Received: #{MultiJson.encode(m)}")
    Severity: Minor
    Found in lib/lita/adapters/glip/message_handler.rb by rubocop

    Prefer single-quoted strings when you don't need string interpolation or special symbols.
    Open

              unless (m['body'].key?(TYPE_PROPERTY_A) && m['body'][TYPE_PROPERTY_A] == "PostAdded") ||
    Severity: Minor
    Found in lib/lita/adapters/glip/message_handler.rb by rubocop

    Checks if uses of quotes match the configured preference.

    Example: EnforcedStyle: single_quotes (default)

    # bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

    Example: EnforcedStyle: double_quotes

    # bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

    Use %q only for strings that contain both single quotes and double quotes.
    Open

      spec.description   = %q{A Glip adapter for Lita.}
    Severity: Minor
    Found in lita-glip.gemspec by rubocop

    Final newline missing.
    Open

    task default: :spec
    Severity: Minor
    Found in Rakefile by rubocop
    Severity
    Category
    Status
    Source
    Language