Module has too many lines. [110/100] Open
module ReviewAssignment
def contributors
# ACS Contributors are just teams, so removed check to see if it is a team assignment
@contributors ||= teams # ACS
end
- Read upRead up
- Exclude checks
This cop checks if the length a module exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.
Assignment Branch Condition size for contributor_to_review is too high. [45.78/15] Open
def contributor_to_review(reviewer, topic)
raise 'Please select a topic' if topics? && topic.nil?
raise 'This assignment does not have topics' if !topics? && topic
# This condition might happen if the reviewer waited too much time in the
# select topic page and other students have already selected this topic.
- Read upRead up
- Exclude checks
This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
Cyclomatic complexity for contributor_to_review is too high. [13/6] Open
def contributor_to_review(reviewer, topic)
raise 'Please select a topic' if topics? && topic.nil?
raise 'This assignment does not have topics' if !topics? && topic
# This condition might happen if the reviewer waited too much time in the
# select topic page and other students have already selected this topic.
- Read upRead up
- Exclude checks
This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.
An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.
Perceived complexity for contributor_to_review is too high. [13/7] Open
def contributor_to_review(reviewer, topic)
raise 'Please select a topic' if topics? && topic.nil?
raise 'This assignment does not have topics' if !topics? && topic
# This condition might happen if the reviewer waited too much time in the
# select topic page and other students have already selected this topic.
- Read upRead up
- Exclude checks
This cop tries to produce a complexity score that's a measure of the
complexity the reader experiences when looking at a method. For that
reason it considers when
nodes as something that doesn't add as much
complexity as an if
or a &&
. Except if it's one of those special
case
/when
constructs where there's no expression after case
. Then
the cop treats it as an if
/elsif
/elsif
... and lets all the when
nodes count. In contrast to the CyclomaticComplexity cop, this cop
considers else
nodes as adding complexity.
Example:
def my_method # 1
if cond # 1
case var # 2 (0.8 + 4 * 0.2, rounded)
when 1 then func_one
when 2 then func_two
when 3 then func_three
when 4..10 then func_other
end
else # 1
do_something until a && b # 2
end # ===
end # 7 complexity points
Assignment Branch Condition size for reject_by_least_reviewed is too high. [20.12/15] Open
def reject_by_least_reviewed(contributor_set)
contributor = contributor_set.min_by {|contributor| contributor.review_mappings.reject {|review_mapping| review_mapping.response.nil? }.count }
min_reviews = contributor.review_mappings.reject {|review_mapping| review_mapping.response.nil? }.count rescue 0
contributor_set.reject! {|contributor| contributor.review_mappings.reject {|review_mapping| review_mapping.response.nil? }.count > min_reviews + review_topic_threshold }
contributor_set
- Read upRead up
- Exclude checks
This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
Assignment Branch Condition size for candidate_topics_to_review is too high. [18.47/15] Open
def candidate_topics_to_review(reviewer)
return nil if sign_up_topics.empty? # This is not a topic assignment
# Initialize contributor set with all teams participating in this assignment
contributor_set = Array.new(contributors)
- Read upRead up
- Exclude checks
This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
Assignment Branch Condition size for signed_up_topic is too high. [17.23/15] Open
def signed_up_topic(team)
# The purpose is to return the topic that the contributor has signed up to do for this assignment.
# Returns a record from the sign_up_topic table that gives the topic_id for which the contributor has signed up
# Look for the topic_id where the team_id equals the contributor id (contributor is a team or a participant)
- Read upRead up
- Exclude checks
This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
Method contributor_to_review
has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open
def contributor_to_review(reviewer, topic)
raise 'Please select a topic' if topics? && topic.nil?
raise 'This assignment does not have topics' if !topics? && topic
# This condition might happen if the reviewer waited too much time in the
# select topic page and other students have already selected this topic.
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Method signed_up_topic
has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
def signed_up_topic(team)
# The purpose is to return the topic that the contributor has signed up to do for this assignment.
# Returns a record from the sign_up_topic table that gives the topic_id for which the contributor has signed up
# Look for the topic_id where the team_id equals the contributor id (contributor is a team or a participant)
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Use find_by
instead of where.first
. Open
topic_id = SignedUpTeam.where(team_id: team.id, is_waitlisted: 0).first.topic_id
- Read upRead up
- Exclude checks
This cop is used to identify usages of where.first
and
change them to use find_by
instead.
Example:
# bad
User.where(name: 'Bruce').first
User.where(name: 'Bruce').take
# good
User.find_by(name: 'Bruce')
Line is too long. [173/160] Open
contributor_set.reject! {|contributor| contributor.review_mappings.reject {|review_mapping| review_mapping.response.nil? }.count > min_reviews + review_topic_threshold }
- Exclude checks
Prefer each
over for
. Open
for signup in signups do
- Read upRead up
- Exclude checks
This cop looks for uses of the for keyword, or each method. The preferred alternative is set in the EnforcedStyle configuration parameter. An each call with a block on a single line is always allowed, however.
Use a guard clause instead of wrapping the code inside a conditional expression. Open
unless SignedUpTeam.where(team_id: team.id, is_waitlisted: 0).empty?
- Read upRead up
- Exclude checks
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