aki017/ZeroFormatter.rb

View on GitHub

Showing 7 of 7 total issues

Method load has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
Open

    def load(klass, bytes)
      object_size = Utils.read_s4(bytes, 0)
      raise "Object size missmatch, expected=#{object_size}, actual=#{bytes.bytesize}" if object_size != bytes.bytesize

      last_index = Utils.read_s4(bytes, 4)
Severity: Minor
Found in lib/zero_formatter/serializer.rb - About 3 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 dump has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

    def dump(value)
      last_index = value.class.fields.last[:index]

      data_headers = []
      data_header = "".force_encoding("ASCII-8bit")
Severity: Minor
Found in lib/zero_formatter/serializer.rb - About 3 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

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

  class Serializer
    module Int8Serializer
      extend self
      Alias = %i(sbyte int8 int_8)

Severity: Major
Found in lib/zero_formatter/serializer/int.rb and 1 other location - About 2 hrs to fix
lib/zero_formatter/serializer/uint.rb on lines 2..67

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

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 Serializer
    module UInt8Serializer
      extend self
      Alias = %i(byte uint8 uint_8)

Severity: Major
Found in lib/zero_formatter/serializer/uint.rb and 1 other location - About 2 hrs to fix
lib/zero_formatter/serializer/int.rb on lines 2..67

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

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

Method dump has 55 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def dump(value)
      last_index = value.class.fields.last[:index]

      data_headers = []
      data_header = "".force_encoding("ASCII-8bit")
Severity: Major
Found in lib/zero_formatter/serializer.rb - About 2 hrs to fix

    Class Utils has 21 methods (exceeds 20 allowed). Consider refactoring.
    Open

      class Utils
        class << self
          def read_s1(bytes, index)
            to_signed(bytes.getbyte(index), 1 << (8 -1))
          end
    Severity: Minor
    Found in lib/zero_formatter/utils.rb - About 2 hrs to fix

      Method load has 43 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def load(klass, bytes)
            object_size = Utils.read_s4(bytes, 0)
            raise "Object size missmatch, expected=#{object_size}, actual=#{bytes.bytesize}" if object_size != bytes.bytesize
      
            last_index = Utils.read_s4(bytes, 4)
      Severity: Minor
      Found in lib/zero_formatter/serializer.rb - About 1 hr to fix
        Severity
        Category
        Status
        Source
        Language