fga-eps-mds/2019.2-Vsign

View on GitHub
backend/app/controllers/v1_controller.rb

Summary

Maintainability
A
0 mins
Test Coverage

Favor a normal if-statement over a modifier clause in a multiline statement.
Open

    render json: {
      message: 'Empresa não encontrada.'
    }, status: :not_found if @company.nil?

Checks for uses of if/unless modifiers with multiple-lines bodies.

Example:

# bad
{
  result: 'this should not happen'
} unless cond

# good
{ result: 'ok' } if cond

Missing top-level class documentation comment.
Open

class V1Controller < ApplicationController

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