Sign upLogin

CardTapp/yext-api

View on GitHub
Star

Showing 8 of 8 total issues

Similar blocks of code found in 2 locations. Consider refactoring.
Open

  module Api
    module Enumerations
      class ErrorCodes
        # Analytics error codes
        # Errors that happen when interacting with the Analytics API
Severity: Major
Found in lib/yext/api/enumerations/error_codes/analytics_errors.rb and 1 other location - About 4 hrs to fix
lib/yext/api/enumerations/error_codes/ecl_errors.rb on lines 4..77

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 139.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

  module Api
    module Enumerations
      class ErrorCodes
        # ECL error codes
        #
Severity: Major
Found in lib/yext/api/enumerations/error_codes/ecl_errors.rb and 1 other location - About 4 hrs to fix
lib/yext/api/enumerations/error_codes/analytics_errors.rb on lines 4..78

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 139.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

File locations_errors.rb has 255 lines of code (exceeds 250 allowed). Consider refactoring.
Open

module Yext
  module Api
    module Enumerations
      class ErrorCodes
        # Locations error codes
Severity: Minor
Found in lib/yext/api/enumerations/error_codes/locations_errors.rb - About 2 hrs to fix

    Method reset_class_uri has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

              def reset_class_uri(env)
            klass = Yext::Api::Utils::ApiFinder.new(env[:url], env[:method]).find_class_name

            return unless klass.present?
    Severity: Minor
    Found in lib/yext/api/utils/middleware/uri_cleanup.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 action_found? has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

            def action_found?(actions)
          return false if actions.blank?

          actions.each do |action|
            next if action[:path_regex].blank?
    Severity: Minor
    Found in lib/yext/api/utils/api_finder.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 find_class_name has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

            def find_class_name
          api_hash = Yext::Api::Utils::ApiFinder.api_hash

          return build_class_name("Yext::Api::LiveApi", api_hash[:live_api]) if uri_path.include?("//liveapi.")
    Severity: Minor
    Found in lib/yext/api/utils/api_finder.rb - About 25 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 reset_uri has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

              def reset_uri
            [Yext::Api::KnowledgeApi::AccountSettings::Account, Yext::Api::AdministrativeApi::Account].each do |account_class|
              next unless account_class.association?(self)

              klass_uri = instance_variable_get(:@uri) || default_uri
    Severity: Minor
    Found in lib/yext/api/concerns/account_child.rb - About 25 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 extract_data_value has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

              def extract_data_value
            data = yext_response_json[:response]

            if data.is_a?(Hash) && (data.key?(:count) || data.length <= 2)
              array_data = data[(data.keys - [:count]).first]
    Severity: Minor
    Found in lib/yext/api/utils/middleware/response_parser.rb - About 25 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

    Severity
    Category
    Status
    Source
    Language