storyblok/storyblok-ruby

View on GitHub

Showing 13 of 13 total issues

Method find_and_fill_links has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
Open

      def find_and_fill_links(content, links)
        return if content.nil? || links.nil? || links.size.zero?

        if content.is_a? Array
          content.each do |item|
Severity: Minor
Found in lib/storyblok/client.rb - About 4 hrs 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

Class Client has 31 methods (exceeds 20 allowed). Consider refactoring.
Open

  class Client
    DEFAULT_CONFIGURATION = {
      secure: true,
      api_version: 2,
      logger: false,
Severity: Minor
Found in lib/storyblok/client.rb - About 3 hrs to fix

    Method find_and_fill_relations has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

          def find_and_fill_relations(content, relation_params, rels)
            return if content.nil? || rels.nil? || rels.size.zero?
    
            if content.is_a? Array
              content.each do |item|
    Severity: Minor
    Found in lib/storyblok/client.rb - About 3 hrs 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

    File client.rb has 282 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require_relative 'request'
    require_relative 'links'
    
    require 'storyblok/richtext'
    require 'rest-client'
    Severity: Minor
    Found in lib/storyblok/client.rb - About 2 hrs to fix

      Method base_url has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

            def base_url
              if !configuration[:api_url]
                region = configuration[:api_region] ? "-#{configuration[:api_region]}" : ""
                "http#{configuration[:secure] ? 's' : ''}://api#{region}.storyblok.com/v#{configuration[:api_version]}"
              else
      Severity: Minor
      Found in lib/storyblok/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 run_request has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

            def run_request(endpoint, query_string)
              logger.info(request: { endpoint: endpoint, query: query_string }) if logger
      
              retries_left = 3
      
      
      Severity: Minor
      Found in lib/storyblok/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 find_and_fill_links has 28 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

            def find_and_fill_links(content, links)
              return if content.nil? || links.nil? || links.size.zero?
      
              if content.is_a? Array
                content.each do |item|
      Severity: Minor
      Found in lib/storyblok/client.rb - About 1 hr to fix

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

            def run_management_request(action, path, payload = {}, additional_headers = {})
              logger.info(request: { path: path, action: action }) if logger
              retries_left = 3
        
              begin
        Severity: Minor
        Found in lib/storyblok/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_nested_query has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

              def build_nested_query(value, prefix = nil)
                case value
                when Array
                  value.map { |v|
                    build_nested_query(v, "#{prefix}[]")
        Severity: Minor
        Found in lib/storyblok/client.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 initialize has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            def initialize(client, endpoint, query = {}, id = nil, bypass_cache = false)
        Severity: Minor
        Found in lib/storyblok/request.rb - About 35 mins to fix

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

                def request_query(query)
                  query[:token] = configuration[:token] if query[:token].nil?
                  query[:version] = configuration[:version] if query[:version].nil?
          
                  unless cache.nil?
          Severity: Minor
          Found in lib/storyblok/client.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

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

                rescue RestClient::TooManyRequests
                  if retries_left != 0
                    retries_left -= 1
                    logger.info("Too many requests. Retry nr. #{(3 - retries_left).to_s} of max. 3 times.") if logger
                    sleep(0.5)
          Severity: Minor
          Found in lib/storyblok/client.rb and 1 other location - About 20 mins to fix
          lib/storyblok/client.rb on lines 250..258

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

          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

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

                  rescue RestClient::TooManyRequests
                    if retries_left != 0
                      retries_left -= 1
                      logger.info("Too many requests. Retry nr. #{(3 - retries_left).to_s} of max. 3 times.") if logger
                      sleep(0.5)
          Severity: Minor
          Found in lib/storyblok/client.rb and 1 other location - About 20 mins to fix
          lib/storyblok/client.rb on lines 168..176

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

          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

          Severity
          Category
          Status
          Source
          Language