rapid7/nexpose-client

View on GitHub
lib/nexpose/site.rb

Summary

Maintainability
D
2 days
Test Coverage

File site.rb has 417 lines of code (exceeds 250 allowed). Consider refactoring.
Open

module Nexpose

  class Connection
    include XMLUtils

Severity: Minor
Found in lib/nexpose/site.rb - About 6 hrs to fix

    Class Site has 34 methods (exceeds 20 allowed). Consider refactoring.
    Open

      class Site < APIObject
        include JsonSerializer
        # The site ID. An ID of -1 is used to designate a site that has not been
        # saved to a Nexpose console.
        attr_accessor :id
    Severity: Minor
    Found in lib/nexpose/site.rb - About 4 hrs to fix

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

          def <=>(other)
            return 1 unless other.respond_to? :from
            from    = IPAddr.new(@from)
            to      = @to.nil? ? from : IPAddr.new(@to)
            cf_from = IPAddr.new(other.from)
      Severity: Minor
      Found in lib/nexpose/site.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 load has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          def self.load(nsc, id)
            uri  = "/api/2.1/site_configurations/#{id}"
            resp = AJAX.get(nsc, uri, AJAX::CONTENT_TYPE::JSON)
            hash = JSON.parse(resp, symbolize_names: true)
            site = self.json_initializer(hash).deserialize(hash)
      Severity: Minor
      Found in lib/nexpose/site.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 initialize has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def initialize(id, name, description = nil, risk_factor = 1.0, risk_score = 0.0)
      Severity: Minor
      Found in lib/nexpose/site.rb - About 35 mins to fix

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

            def include?(single_ip)
              return false unless single_ip.respond_to? :from
              from  = IPAddr.new(@from)
              to    = @to.nil? ? from : IPAddr.new(@to)
              other = IPAddr.new(single_ip)
        Severity: Minor
        Found in lib/nexpose/site.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

        Method initialize has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            def initialize(from, to = nil)
              @from = from
              @to   = to unless from == to
        
              return unless @to.nil?
        Severity: Minor
        Found in lib/nexpose/site.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

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

            def remove_excluded_ip_range(from, to)
              from_ip = IPAddr.new(from)
              to_ip   = IPAddr.new(to)
              (from_ip..to_ip)
              raise 'Invalid IP range specified' if (from_ip..to_ip).to_a.size.zero?
        Severity: Minor
        Found in lib/nexpose/site.rb and 1 other location - About 1 hr to fix
        lib/nexpose/site.rb on lines 254..262

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

        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

            def remove_included_ip_range(from, to)
              from_ip = IPAddr.new(from)
              to_ip   = IPAddr.new(to)
              (from_ip..to_ip)
              raise 'Invalid IP range specified' if (from_ip..to_ip).to_a.size.zero?
        Severity: Minor
        Found in lib/nexpose/site.rb and 1 other location - About 1 hr to fix
        lib/nexpose/site.rb on lines 300..308

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

        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

            def exclude_ip_range(from, to)
              from_ip = IPAddr.new(from)
              to_ip   = IPAddr.new(to)
              (from_ip..to_ip)
              raise 'Invalid IP range specified' if (from_ip..to_ip).to_a.size.zero?
        Severity: Minor
        Found in lib/nexpose/site.rb and 1 other location - About 50 mins to fix
        lib/nexpose/site.rb on lines 240..248

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

        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

            def include_ip_range(from, to)
              from_ip = IPAddr.new(from)
              to_ip   = IPAddr.new(to)
              (from_ip..to_ip)
              raise 'Invalid IP range specified' if (from_ip..to_ip).to_a.size.zero?
        Severity: Minor
        Found in lib/nexpose/site.rb and 1 other location - About 50 mins to fix
        lib/nexpose/site.rb on lines 286..294

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

        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