postmodern/ruby-nmap

View on GitHub

Showing 19 of 19 total issues

File command.rb has 370 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'command_mapper/command'

module Nmap
  #
  # ## Nmap options:
Severity: Minor
Found in lib/nmap/command.rb - About 4 hrs to fix

    Class Host has 33 methods (exceeds 20 allowed). Consider refactoring.
    Open

        class Host
    
          include Enumerable
    
          #
    Severity: Minor
    Found in lib/nmap/xml/host.rb - About 4 hrs to fix

      Class XML has 26 methods (exceeds 20 allowed). Consider refactoring.
      Open

        class XML
      
          include Enumerable
      
          # The parsed XML document.
      Severity: Minor
      Found in lib/nmap/xml.rb - About 3 hrs to fix

        Method validate has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
        Open

              def validate(value)
                case value
                when Hash
                  if value.empty?
                    return [false, "Hash value cannot be empty"]
        Severity: Minor
        Found in lib/nmap/command.rb - About 2 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

        Method validate has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
        Open

              def validate(value)
                case value
                when Hash
                  if value.empty?
                    return [false, "cannot be empty"]
        Severity: Minor
        Found in lib/nmap/command.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 validate has 31 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

              def validate(value)
                case value
                when Hash
                  if value.empty?
                    return [false, "Hash value cannot be empty"]
        Severity: Minor
        Found in lib/nmap/command.rb - About 1 hr to fix

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

                def validate(value)
                  case value
                  when Range
                    valid, message = super(value.begin)
          
          
          Severity: Minor
          Found in lib/nmap/command.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 validate has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

                def validate(value)
                  case value
                  when Integer then true
                  else
                    valid, message = super(value)
          Severity: Minor
          Found in lib/nmap/command.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

          Avoid too many return statements within this method.
          Open

                      return [false, "not a valid port range list (#{value.inspect})"]
          Severity: Major
          Found in lib/nmap/command.rb - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                        return [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
            Severity: Major
            Found in lib/nmap/command.rb - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                          return [false, "must only contain URG, ACK, PSH, RST, SYN, or FIN"]
              Severity: Major
              Found in lib/nmap/command.rb - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                          return true
                Severity: Major
                Found in lib/nmap/command.rb - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                              return [false, "Array must only contain the values :urg, :ack, :psh, :rst, :syn, or :fin"]
                  Severity: Major
                  Found in lib/nmap/command.rb - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                              return true
                    Severity: Major
                    Found in lib/nmap/command.rb - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                  return [valid, message]
                      Severity: Major
                      Found in lib/nmap/command.rb - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                    return [false, "Array value cannot be empty"]
                        Severity: Major
                        Found in lib/nmap/command.rb - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                    return true
                          Severity: Major
                          Found in lib/nmap/command.rb - About 30 mins to fix

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

                                      valid, message = super(value)
                            
                                      unless valid
                                        return [valid, message]
                                      end
                            Severity: Minor
                            Found in lib/nmap/command.rb and 1 other location - About 20 mins to fix
                            lib/nmap/command.rb on lines 573..585

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

                            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

                                      valid, message = super(value)
                            
                                      unless valid
                                        return [valid, message]
                                      end
                            Severity: Minor
                            Found in lib/nmap/command.rb and 1 other location - About 20 mins to fix
                            lib/nmap/command.rb on lines 461..473

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

                            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