Assignment Branch Condition size for run is too high. [34.31/15] Open
def self.run(assignment_id)
assignment = Assignment.find(assignment_id)
teams = Team.where(parent_id: assignment_id)
code_assignment_submission_id = create_new_assignment_submission(assignment.name + ' (Code)')
- 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 has too many lines. [25/10] Open
def self.store_results(assignment_submission_simicheck_id, threshold)
response = SimiCheckWebService.get_similarity_nxn(assignment_submission_simicheck_id)
json_response = JSON.parse(response.body)
json_response['similarities'].each do |similarity|
next unless similarity['similarity'] >= threshold
- Read upRead up
- Exclude checks
This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.
Assignment Branch Condition size for store_results is too high. [29.09/15] Open
def self.store_results(assignment_submission_simicheck_id, threshold)
response = SimiCheckWebService.get_similarity_nxn(assignment_submission_simicheck_id)
json_response = JSON.parse(response.body)
json_response['similarities'].each do |similarity|
next unless similarity['similarity'] >= threshold
- 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 has too many lines. [22/10] Open
def self.run(assignment_id)
assignment = Assignment.find(assignment_id)
teams = Team.where(parent_id: assignment_id)
code_assignment_submission_id = create_new_assignment_submission(assignment.name + ' (Code)')
- Read upRead up
- Exclude checks
This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.
Method run
has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring. Open
def self.run(assignment_id)
assignment = Assignment.find(assignment_id)
teams = Team.where(parent_id: assignment_id)
code_assignment_submission_id = create_new_assignment_submission(assignment.name + ' (Code)')
- 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
Do not place comments on the same line as the end
keyword. Open
end # each submission per team
- Read upRead up
- Exclude checks
This cop checks for comments put on the same line as some keywords.
These keywords are: begin
, class
, def
, end
, module
.
Note that some comments (such as :nodoc:
and rubocop:disable
) are
allowed.
Example:
# bad
if condition
statement
end # end if
# bad
class X # comment
statement
end
# bad
def x; end # comment
# good
if condition
statement
end
# good
class X # :nodoc:
y
end
Do not place comments on the same line as the end
keyword. Open
end # each team
- Read upRead up
- Exclude checks
This cop checks for comments put on the same line as some keywords.
These keywords are: begin
, class
, def
, end
, module
.
Note that some comments (such as :nodoc:
and rubocop:disable
) are
allowed.
Example:
# bad
if condition
statement
end # end if
# bad
class X # comment
statement
end
# bad
def x; end # comment
# good
if condition
statement
end
# good
class X # :nodoc:
y
end
Missing top-level module documentation comment. Open
module PlagiarismCheckerHelper
- Read upRead up
- Exclude checks
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