Mass assignment is not restricted using attr_accessible Open
class Search < ActiveRecord::Base
- Read upRead up
- Exclude checks
This warning comes up if a model does not limit what attributes can be set through mass assignment.
In particular, this check looks for attr_accessible
inside model definitions. If it is not found, this warning will be issued.
Brakeman also warns on use of attr_protected
- especially since it was found to be vulnerable to bypass. Warnings for mass assignment on models using attr_protected
will be reported, but at a lower confidence level.
Note that disabling mass assignment globally will suppress these warnings.
Method has too many lines. [14/10] Open
def sort_type_options_for(sort_type, action, with_relevance = false)
with_relevance = with_relevance || (action == 'for')
sort_type = sort_type(action: action, user_specified: sort_type, default: 'none')
- 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 sort_type_options_for is too high. [18.38/15] Open
def sort_type_options_for(sort_type, action, with_relevance = false)
with_relevance = with_relevance || (action == 'for')
sort_type = sort_type(action: action, user_specified: sort_type, default: 'none')
- 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 update_sort_direction_value_for_pqf_query is too high. [8/6] Open
def update_sort_direction_value_for_pqf_query(requested, sort_type = nil)
sort_type = @pqf_query.sort_spec if sort_type.blank?
date_types = Search.date_types
- 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 update_sort_direction_value_for_pqf_query is too high. [8/7] Open
def update_sort_direction_value_for_pqf_query(requested, sort_type = nil)
sort_type = @pqf_query.sort_spec if sort_type.blank?
date_types = Search.date_types
- 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
Method sort_type_options_for
has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring. Open
def sort_type_options_for(sort_type, action, with_relevance = false)
with_relevance = with_relevance || (action == 'for')
sort_type = sort_type(action: action, user_specified: sort_type, default: 'none')
- 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
Consider simplifying this complex logical expression. Open
@pqf_query.direction_value = 2 if (date_types.include?(sort_type) && (requested.nil? || requested != 'reverse')) || (!date_types.include?(sort_type) && !requested.nil? && requested == 'reverse')
Use the return of the conditional for variable assignment and comparison. Open
if type == 'relevance'
sort_type_options += '<option class="none" value="none"'
else
sort_type_options += "<option class=\"#{type}\" value=\"#{type}\""
end
- Exclude checks
Use self-assignment shorthand ||=
. Open
with_relevance = with_relevance || (action == 'for')
- Read upRead up
- Exclude checks
This cop enforces the use the shorthand for self-assignment.
Example:
# bad
x = x + 1
# good
x += 1