ronin-rb/ronin-support

View on GitHub
lib/ronin/support/binary/stream/methods.rb

Summary

Maintainability
D
2 days
Test Coverage

Class Stream has 103 methods (exceeds 20 allowed). Consider refactoring.
Open

      class Stream
        #
        # Adds `read_*`/`write_*` methods for reading and writing binary data
        # types.
        #
Severity: Major
Found in lib/ronin/support/binary/stream/methods.rb - About 1 day to fix

    File methods.rb has 377 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require 'ronin/support/binary/buffer'
    require 'ronin/support/binary/array'
    require 'ronin/support/binary/struct'
    require 'ronin/support/binary/union'
    
    
    Severity: Minor
    Found in lib/ronin/support/binary/stream/methods.rb - About 5 hrs to fix

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

                def read_string(length=nil)
                  new_string = if (encoding = external_encoding)
                                 String.new('', encoding: encoding)
                               else
                                 String.new('')
      Severity: Minor
      Found in lib/ronin/support/binary/stream/methods.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

      There are no issues that match your filters.

      Category
      Status