Sign upLogin

fga-gpp-mds/2017.1-Escola-X

View on GitHub
Star
app/uploaders/image_uploader.rb

Summary

Maintainability
A
0 mins
Test Coverage

ImageUploader has no descriptive comment
Open

class ImageUploader < CarrierWave::Uploader::Base
Severity: Minor
Found in app/uploaders/image_uploader.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

Line is too long. [112/80]
Open

  #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
Severity: Minor
Found in app/uploaders/image_uploader.rb by rubocop

Unnecessary utf-8 encoding comment.
Open

# encoding: utf-8
Severity: Minor
Found in app/uploaders/image_uploader.rb by rubocop

Extra empty line detected at class body beginning.
Open


  # Include RMagick or MiniMagick support:
Severity: Minor
Found in app/uploaders/image_uploader.rb by rubocop

This cops checks if empty lines around the bodies of classes match the configuration.

Example: EnforcedStyle: empty_lines

# good

class Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

class Foo
  class Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
class Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

class Foo
  def bar
    # ...
  end
end

Extra empty line detected at class body end.
Open


end
Severity: Minor
Found in app/uploaders/image_uploader.rb by rubocop

This cops checks if empty lines around the bodies of classes match the configuration.

Example: EnforcedStyle: empty_lines

# good

class Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

class Foo
  class Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
class Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

class Foo
  def bar
    # ...
  end
end

Line is too long. [81/80]
Open

  # Avoid using model.id or version_name here, see uploader/store.rb for details.
Severity: Minor
Found in app/uploaders/image_uploader.rb by rubocop

Missing top-level class documentation comment.
Open

class ImageUploader < CarrierWave::Uploader::Base
Severity: Minor
Found in app/uploaders/image_uploader.rb by rubocop

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

There are no issues that match your filters.

Category
Status