nabeelamjad/poke-api

View on GitHub
examples/spiral_search.rb

Summary

Maintainability
B
6 hrs
Test Coverage

Method has too many lines. [38/30]
Open

def find_poi(client, lat, lng)
  step_size = 0.0015
  step_limit = 49

  coords = generate_spiral(lat, lng, step_size, step_limit)
Severity: Minor
Found in examples/spiral_search.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 find_poi has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

def find_poi(client, lat, lng)
  step_size = 0.0015
  step_limit = 49

  coords = generate_spiral(lat, lng, step_size, step_limit)
Severity: Minor
Found in examples/spiral_search.rb - About 1 hr to fix

    Method generate_spiral has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def generate_spiral(starting_lat, starting_lng, step_size, step_limit)
      coords = [{ lat: starting_lat, lng: starting_lng }]
      steps = 1
      x = 0
      y = 0
    Severity: Minor
    Found in examples/spiral_search.rb - About 1 hr to fix

      Block has too many lines. [31/25]
      Open

        coords.each do |coord|
          lat = coord[:lat]
          lng = coord[:lng]
          client.store_lat_lng(lat, lng)
      
      
      Severity: Minor
      Found in examples/spiral_search.rb by rubocop

      This cop checks if the length of a block exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable. The cop can be configured to ignore blocks passed to certain methods.

      Method find_poi has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

      def find_poi(client, lat, lng)
        step_size = 0.0015
        step_limit = 49
      
        coords = generate_spiral(lat, lng, step_size, step_limit)
      Severity: Minor
      Found in examples/spiral_search.rb - About 45 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 generate_spiral has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

      def generate_spiral(starting_lat, starting_lng, step_size, step_limit)
        coords = [{ lat: starting_lat, lng: starting_lng }]
        steps = 1
        x = 0
        y = 0
      Severity: Minor
      Found in examples/spiral_search.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

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

          while 2 * y * d < m && steps < step_limit
            y += d
            steps += 1
            lat = x * step_size + starting_lat + rand * ((rlow - rhigh) + rlow)
            lng = y * step_size + starting_lng + rand * ((rlow - rhigh) + rlow)
      Severity: Major
      Found in examples/spiral_search.rb and 1 other location - About 1 hr to fix
      examples/spiral_search.rb on lines 15..21

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

      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

          while 2 * x * d < m && steps < step_limit
            x += d
            steps += 1
            lat = x * step_size + starting_lat + rand * ((rlow - rhigh) + rlow)
            lng = y * step_size + starting_lng + rand * ((rlow - rhigh) + rlow)
      Severity: Major
      Found in examples/spiral_search.rb and 1 other location - About 1 hr to fix
      examples/spiral_search.rb on lines 22..28

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

      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

      There are no issues that match your filters.

      Category
      Status