grokify/ringcentral-sdk-ruby

View on GitHub

Showing 129 of 129 total issues

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

      def send(request)
        return @client.request(request) if request.is_a? RingCentralSdk::Helpers::Request
        raise(ArgumentError, 'Request is not a ...Helpers::Request or Hash') unless request.is_a? Hash

        verb = request.key?(:verb) ? request[:verb].to_s.downcase : 'get'

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. [17/15]
Open

        def get_department_members(department_id)
          department_id = department_id.to_s unless department_id.is_a? String
          if department_id !~ /^[0-9]+$/
            raise 'department_id parameter must be a positive integer'
          end

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 alive? is too high. [8/6]
Open

      def alive?
        s = @_subscription
        if
          (s.key?('deliveryMode') && s['deliveryMode']) \
          && (s['deliveryMode'].key?('subscriberKey') && s['deliveryMode']['subscriberKey']) \

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 send is too high. [8/7]
Open

      def send(request)
        return @client.request(request) if request.is_a? RingCentralSdk::Helpers::Request
        raise(ArgumentError, 'Request is not a ...Helpers::Request or Hash') unless request.is_a? Hash

        verb = request.key?(:verb) ? request[:verb].to_s.downcase : 'get'

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

Perceived complexity for alive? is too high. [8/7]
Open

      def alive?
        s = @_subscription
        if
          (s.key?('deliveryMode') && s['deliveryMode']) \
          && (s['deliveryMode'].key?('subscriberKey') && s['deliveryMode']['subscriberKey']) \

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 set_token is too high. [31.06/30]
Open

      def set_token(token)
        if token.is_a? Hash
          token = OAuth2::AccessToken.from_hash(@oauth2client, token)
        end

Severity: Minor
Found in lib/ringcentral_sdk/rest/client.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. [16/15]
Open

      def nil_subscription
        {
          'eventFilters'    => [],
          'expirationTime'  => '', # 2014-03-12T19:54:35.613Z
          'expiresIn'       => 0,

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 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.

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

      def inflate_retry
        if !defined?(@retry) || @retry.nil?
          @retry = false
        elsif @retry.is_a? String
          @retry = @retry.to_s.strip.downcase == 'true' ? true : false

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.

Assignment Branch Condition size for retrieve is too high. [31.21/30]
Open

        def retrieve(params = {}, retrieve_all = true)
          @last_retrieved = Time.now.to_i
          uri = URI.parse "account/#{@account_id}/extension"
          uri.query = URI.encode_www_form(params) unless params.empty?
          res = @client.http.get do |req|

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

Perceived complexity for inflate_retry is too high. [8/7]
Open

      def inflate_retry
        if !defined?(@retry) || @retry.nil?
          @retry = false
        elsif @retry.is_a? String
          @retry = @retry.to_s.strip.downcase == 'true' ? true : false

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 load_environment is too high. [30.22/30]
Open

      def load_environment
        Dotenv.load
        @server_url    = ENV['RINGCENTRAL_SERVER_URL']    if ENV.key? 'RINGCENTRAL_SERVER_URL'
        @client_id     = ENV['RINGCENTRAL_CLIENT_ID']     if ENV.key? 'RINGCENTRAL_CLIENT_ID'
        @client_secret = ENV['RINGCENTRAL_CLIENT_SECRET'] if ENV.key? 'RINGCENTRAL_CLIENT_SECRET'

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 load_environment has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

      def load_environment
        Dotenv.load
        @server_url    = ENV['RINGCENTRAL_SERVER_URL']    if ENV.key? 'RINGCENTRAL_SERVER_URL'
        @client_id     = ENV['RINGCENTRAL_CLIENT_ID']     if ENV.key? 'RINGCENTRAL_CLIENT_ID'
        @client_secret = ENV['RINGCENTRAL_CLIENT_SECRET'] if ENV.key? 'RINGCENTRAL_CLIENT_SECRET'
Severity: Minor
Found in lib/ringcentral_sdk/rest/configuration.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 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

Method get_department_members has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

        def get_department_members(department_id)
          department_id = department_id.to_s unless department_id.is_a? String
          if department_id !~ /^[0-9]+$/
            raise 'department_id parameter must be a positive integer'
          end
Severity: Minor
Found in lib/ringcentral_sdk/rest/cache/extensions.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 set_token has 28 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def set_token(token)
        if token.is_a? Hash
          token = OAuth2::AccessToken.from_hash(@oauth2client, token)
        end

Severity: Minor
Found in lib/ringcentral_sdk/rest/client.rb - About 1 hr to fix

    Method inflate_retry has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

          def inflate_retry
            if !defined?(@retry) || @retry.nil?
              @retry = false
            elsif @retry.is_a? String
              @retry = @retry.to_s.strip.downcase == 'true' ? true : false
    Severity: Minor
    Found in lib/ringcentral_sdk/rest/configuration.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 create_url has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

          def create_url(url, add_server = false, add_method = nil, add_token = false)
            built_url = ''
            has_http = !url.index('http://').nil? && !url.index('https://').nil?
    
            built_url += @config.server_url if add_server && !has_http
    Severity: Minor
    Found in lib/ringcentral_sdk/rest/client.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 build_url has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

          def build_url(path)
            path = [path] unless path.is_a? Array
    
            unless path.empty?
              path0 = path[0].to_s
    Severity: Minor
    Found in lib/ringcentral_sdk/rest/simple_client.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 subscribe has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def subscribe(events = nil)
            set_events(events) if events.is_a? Array
    
            raise 'Events are undefined' unless @event_filters.is_a?(Array) && !@event_filters.empty?
            
    Severity: Minor
    Found in lib/ringcentral_sdk/rest/subscription.rb - About 1 hr to fix
      Severity
      Category
      Status
      Source
      Language