Sign upLogin

Kercode/tutti_gruppi

View on GitHub
Star
app/controllers/application_controller.rb

Summary

Maintainability
A
0 mins
Test Coverage

ApplicationController has no descriptive comment
Open

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#remove_role calls 'target.userable_id' 3 times
Open

      Admin.find(target.userable_id).destroy
    when 'Manager'
      Manager.find(target.userable_id).destroy
    when 'Member'
      Member.find(target.userable_id).destroy
Severity: Minor
Found in app/controllers/application_controller.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

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

  def remove_role(id)
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.

ApplicationController#configure_permitted_parameters has the variable name 'u'
Open

    devise_parameter_sanitizer.permit(:account_update) do |u|
Severity: Minor
Found in app/controllers/application_controller.rb by reek

An Uncommunicative Variable Name is a variable name that doesn't communicate its intent well enough.

Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

There are no issues that match your filters.

Category
Status