Sign upLogin

kigster/sym-crypt

View on GitHub
Star

Showing 6 of 6 total issues

Method present? has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    def present?
      return false if self.nil?
      if self.is_a?(String)
        return false if self == ''
      end
Severity: Minor
Found in lib/sym/crypt.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

        def encr(data, key, iv = nil)
          raise Sym::Crypt::Errors::NoPrivateKeyFound unless key.present?
          raise Sym::Crypt::Errors::NoDataProvided unless data.present?
          encrypt_data(data, encryption_config.data_cipher, iv) do |cipher_struct|
            cipher_struct.cipher.key = decode_key(key)
Severity: Minor
Found in lib/sym/crypt/extensions/instance_methods.rb and 1 other location - About 30 mins to fix
lib/sym/crypt/extensions/instance_methods.rb on lines 33..37

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

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

        def decr(encrypted_data, key, iv = nil)
          raise Sym::Crypt::Errors::NoPrivateKeyFound unless key.present?
          raise Sym::Crypt::Errors::NoDataProvided unless encrypted_data.present?
          decrypt_data(encrypted_data, encryption_config.data_cipher, iv) do |cipher_struct|
            cipher_struct.cipher.key = decode_key(key)
Severity: Minor
Found in lib/sym/crypt/extensions/instance_methods.rb and 1 other location - About 30 mins to fix
lib/sym/crypt/extensions/instance_methods.rb on lines 24..28

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

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

Avoid parameter lists longer than 5 parameters. [6/5]
Open

      def initialize(
        encrypted_data:, # [Blob] Binary encrypted data (possibly compressed)
        iv:, # [String] IV used to encrypt the data
        cipher_name:, # [String] Name of the cipher used
        salt: nil, # [Integer] For password-encrypted data this is the salt
Severity: Minor
Found in lib/sym/data/wrapper_struct.rb by rubocop

This cop checks for methods with too many parameters. The maximum number of parameters is configurable. Keyword arguments can optionally be excluded from the total count.

Method Sym::Data::Decoder#data is defined at both lib/sym/data/decoder.rb:8 and lib/sym/data/decoder.rb:8.
Open

      attr_accessor :data, :data_encoded, :data
Severity: Minor
Found in lib/sym/data/decoder.rb by rubocop

This cop checks for duplicated instance (or singleton) method definitions.

Example:

# bad

def duplicated
  1
end

def duplicated
  2
end

Example:

# bad

def duplicated
  1
end

alias duplicated other_duplicated

Example:

# good

def duplicated
  1
end

def other_duplicated
  2
end

Useless assignment to variable - e.
Open

          rescue Zlib::Error => e
Severity: Minor
Found in lib/sym/data/decoder.rb by rubocop

This cop checks for every useless assignment to local variable in every scope. The basic idea for this cop was from the warning of ruby -cw:

assigned but unused variable - foo

Currently this cop has advanced logic that detects unreferenced reassignments and properly handles varied cases such as branch, loop, rescue, ensure, etc.

Example:

# bad

def some_method
  some_var = 1
  do_something
end

Example:

# good

def some_method
  some_var = 1
  do_something(some_var)
end
Severity
Category
Status
Source
Language