Sign upLogin

lujanfernaud/prevy

View on GitHub
Star
app/services/notifiers/group_roles/removed_group_role_notifier.rb

Summary

Maintainability
A
20 mins
Test Coverage

RemovedGroupRoleNotifier has no descriptive comment
Open

class RemovedGroupRoleNotifier
Severity: Minor
Found in app/services/notifiers/group_roles/removed_group_role_notifier.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

Similar blocks of code found in 2 locations. Consider refactoring.
Open

  def call
    GroupRoleNotification.create(
      user:    user,
      group:   group,
      message: "You no longer have #{role} role in #{group.name}."
Severity: Minor
Found in app/services/notifiers/group_roles/removed_group_role_notifier.rb and 1 other location - About 20 mins to fix
app/services/notifiers/group_roles/new_group_role_notifier.rb on lines 14..23

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 28.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Inconsistent indentation detected.
Open

    attr_reader :user, :group, :role
Severity: Minor
Found in app/services/notifiers/group_roles/removed_group_role_notifier.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Missing top-level class documentation comment.
Open

class RemovedGroupRoleNotifier
Severity: Minor
Found in app/services/notifiers/group_roles/removed_group_role_notifier.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