rapid7/metasploit-framework

View on GitHub
lib/postgres/postgres-pr/message.rb

Summary

Maintainability
D
1 day
Test Coverage

File message.rb has 566 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'postgres_msf'
require 'postgres/buffer'
require 'rex/io/stream'

# Monkeypatch to preserve original code intent
Severity: Major
Found in lib/postgres/postgres-pr/message.rb - About 1 day to fix

    Method read has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

      def self.read(stream, startup=false)
        type = stream.read_exactly_n_bytes(1) unless startup
        length = stream.read_exactly_n_bytes(4).to_s.unpack('N').first  # FIXME: length should be signed, not unsigned
    
        if length.nil?
    Severity: Minor
    Found in lib/postgres/postgres-pr/message.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 dump has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

      def dump
        sz = @columns.inject(2) {|sum, col| sum + 4 + (col ? col.size : 0)}
        super(sz) do |buffer|
          buffer.write_int16_network(@columns.size)
          @columns.each {|col|
    Severity: Minor
    Found in lib/postgres/postgres-pr/message.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 parse has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

      def parse(buffer)
        super do
          @field_type = buffer.read_byte
          break if @field_type == 0
          @field_values = []
    Severity: Minor
    Found in lib/postgres/postgres-pr/message.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 dump has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

      def dump
        raise ArgumentError if @field_type == 0 and not @field_values.empty?
    
        sz = 1
        sz += @field_values.inject(1) {|sum, fld| sum + fld.size + 1} unless @field_type == 0
    Severity: Minor
    Found in lib/postgres/postgres-pr/message.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

    class CommandComplete < Message
      register_message_type 'C'
      fields :cmd_tag
    
      def dump
    Severity: Minor
    Found in lib/postgres/postgres-pr/message.rb and 1 other location - About 15 mins to fix
    lib/postgres/postgres-pr/message.rb on lines 628..640

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

    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

    class Query < Message
      register_message_type 'Q'
      fields :query
    
      def dump
    Severity: Minor
    Found in lib/postgres/postgres-pr/message.rb and 1 other location - About 15 mins to fix
    lib/postgres/postgres-pr/message.rb on lines 516..528

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

    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