Sign upLogin

hpi-swt2/sport-portal

View on GitHub
Star
app/controllers/application_controller.rb

Summary

Maintainability
A
0 mins
Test Coverage

ApplicationController has no descriptive comment
Confirmed

class ApplicationController < ActionController::Base
Severity: Minor
Found in app/controllers/application_controller.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

ApplicationController#set_locale doesn't depend on instance state (maybe move it to another class?)
Open

    def set_locale
Severity: Minor
Found in app/controllers/application_controller.rb by reek

A Utility Function is any instance method that has no dependency on the state of the instance.

There are no issues that match your filters.

Category
Status