Sign upLogin

expertiza/expertiza

View on GitHub
Star
app/models/course_team.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
97%

Missing top-level class documentation comment.
Open

class CourseTeam < Team
Severity: Minor
Found in app/models/course_team.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

Use a guard clause instead of wrapping the code inside a conditional expression.
Open

    if CourseParticipant.find_by(parent_id: course_id, user_id: user.id).nil?
Severity: Minor
Found in app/models/course_team.rb by rubocop

Use a guard clause instead of wrapping the code inside a conditional expression

Example:

# bad
def test
  if something
    work
  end
end

# good
def test
  return unless something
  work
end

# also good
def test
  work if something
end

# bad
if something
  raise 'exception'
else
  ok
end

# good
raise 'exception' if something
ok

Use the return of the conditional for variable assignment and comparison.
Open

    if assignment.auto_assign_mentor
      new_team = MentoredTeam.create_team_and_node(assignment_id)
    else
      new_team = AssignmentTeam.create_team_and_node(assignment_id)
    end
Severity: Minor
Found in app/models/course_team.rb by rubocop

There are no issues that match your filters.

Category
Status