Sign upLogin

lujanfernaud/prevy

View on GitHub
Star
app/controllers/users/omniauth_callbacks_controller.rb

Summary

Maintainability
A
0 mins
Test Coverage

Users::OmniauthCallbacksController has no descriptive comment
Open

class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
Severity: Minor
Found in app/controllers/users/omniauth_callbacks_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

Use nested module/class definitions instead of compact style.
Open

class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
Severity: Minor
Found in app/controllers/users/omniauth_callbacks_controller.rb by rubocop

This cop checks the style of children definitions at classes and modules. Basically there are two different styles:

Example: EnforcedStyle: nested (default)

# good
# have each child on its own line
class Foo
  class Bar
  end
end

Example: EnforcedStyle: compact

# good
# combine definitions as much as possible
class Foo::Bar
end

The compact style is only forced for classes/modules with one child.

There are no issues that match your filters.

Category
Status