Sign upLogin

wilsonsilva/nostr

View on GitHub
Star

Showing 5 of 5 total issues

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

  class PrivateKey < Key
    # Human-readable part of the Bech32 encoded address
    #
    # @api private
    #
Severity: Minor
Found in lib/nostr/private_key.rb and 1 other location - About 30 mins to fix
lib/nostr/public_key.rb on lines 5..33

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

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 PublicKey < Key
    # Human-readable part of the Bech32 encoded address
    #
    # @api private
    #
Severity: Minor
Found in lib/nostr/public_key.rb and 1 other location - About 30 mins to fix
lib/nostr/private_key.rb on lines 5..33

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

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 validate_hex_value has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    def validate_hex_value(hex_value)
      raise InvalidKeyTypeError, 'private'   unless hex_value.is_a?(String)
      raise InvalidKeyLengthError, 'private' unless hex_value.size == Key::LENGTH
      raise InvalidKeyFormatError, 'private' unless hex_value.match(Key::FORMAT)
    end
Severity: Minor
Found in lib/nostr/private_key.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

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

    def validate_hex_value(hex_value)
      raise InvalidKeyTypeError, 'public' unless hex_value.is_a?(String)
      raise InvalidKeyLengthError, 'public' unless hex_value.size == Key::LENGTH
      raise InvalidKeyFormatError, 'public' unless hex_value.match(Key::FORMAT)
    end
Severity: Minor
Found in lib/nostr/public_key.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

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

    def validate(hex_value)
      raise InvalidSignatureTypeError   unless hex_value.is_a?(String)
      raise InvalidSignatureLengthError unless hex_value.size == LENGTH
      raise InvalidSignatureFormatError unless hex_value.match(FORMAT)
    end
Severity: Minor
Found in lib/nostr/signature.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

Severity
Category
Status
Source
Language