SleeplessByte/shrine-content_addressable

View on GitHub
lib/content_addressable_file/acts_as_uploaded_file.rb

Summary

Maintainability
A
1 hr
Test Coverage

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

      def download(*args)
        if any_storage(:respond_to?, :download)
          tempfile = pin_storage(:download, id, *args)
        else
          tempfile = Tempfile.new(['content-addressable', id], binmode: true)
Severity: Minor
Found in lib/content_addressable_file/acts_as_uploaded_file.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

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

      def any_storage(method, *args)
        self.class.storages.each do |storage|
          result = storage.send(method, *args) rescue next
          break result if result
        end
Severity: Minor
Found in lib/content_addressable_file/acts_as_uploaded_file.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

Missing top-level module documentation comment.
Open

  module ActsAsUploadedFile

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Missing top-level module documentation comment.
Open

    module ClassMethods

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Missing top-level module documentation comment.
Open

    module InstanceMethods

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Line is too long. [81/80]
Open

      # Calls `#url` on the storage where the file is first found, forwarding any

Line is too long. [81/80]
Open

      # registered storages. use #register_read_only_storage to prevent deletion.

There are no issues that match your filters.

Category
Status