Assignment Branch Condition size for format_for_friendly_urls is too high. [23.62/15] Open
def format_for_friendly_urls(topic_version = false, unicode = false)
skip_titles = [SystemSetting.no_public_version_title, SystemSetting.blank_title]
# we use self.attributes['title'] here rather than self.title
# because depending on how we selected this item, self.title
- 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. [18/10] Open
def format_friendly_unicode_for(string, options = {})
demarkator = options[:demarkator].nil? ? '-' : options[:demarkator]
at_start = options[:at_start].nil? ? true : options[:at_start]
at_end = options[:at_end].nil? ? false : options[:at_end]
- 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 has too many lines. [16/10] Open
def format_for_friendly_urls(topic_version = false, unicode = false)
skip_titles = [SystemSetting.no_public_version_title, SystemSetting.blank_title]
# we use self.attributes['title'] here rather than self.title
# because depending on how we selected this item, self.title
- 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 format_friendly_unicode_for is too high. [20.86/15] Open
def format_friendly_unicode_for(string, options = {})
demarkator = options[:demarkator].nil? ? '-' : options[:demarkator]
at_start = options[:at_start].nil? ? true : options[:at_start]
at_end = options[:at_end].nil? ? false : options[:at_end]
- 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 format_for_friendly_urls
has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring. Open
def format_for_friendly_urls(topic_version = false, unicode = false)
skip_titles = [SystemSetting.no_public_version_title, SystemSetting.blank_title]
# we use self.attributes['title'] here rather than self.title
# because depending on how we selected this item, self.title
- 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 format_friendly_unicode_for
has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring. Open
def format_friendly_unicode_for(string, options = {})
demarkator = options[:demarkator].nil? ? '-' : options[:demarkator]
at_start = options[:at_start].nil? ? true : options[:at_start]
at_end = options[:at_end].nil? ? false : options[:at_end]
- 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
Perceived complexity for format_for_friendly_urls is too high. [9/7] Open
def format_for_friendly_urls(topic_version = false, unicode = false)
skip_titles = [SystemSetting.no_public_version_title, SystemSetting.blank_title]
# we use self.attributes['title'] here rather than self.title
# because depending on how we selected this item, self.title
- 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
Cyclomatic complexity for format_for_friendly_urls is too high. [8/6] Open
def format_for_friendly_urls(topic_version = false, unicode = false)
skip_titles = [SystemSetting.no_public_version_title, SystemSetting.blank_title]
# we use self.attributes['title'] here rather than self.title
# because depending on how we selected this item, self.title
- 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 format_friendly_unicode_for is too high. [8/7] Open
def format_friendly_unicode_for(string, options = {})
demarkator = options[:demarkator].nil? ? '-' : options[:demarkator]
at_start = options[:at_start].nil? ? true : options[:at_start]
at_end = options[:at_end].nil? ? false : options[:at_end]
- 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
end
at 60, 22 is not aligned with if
at 52, 8. Open
end
- Read upRead up
- Exclude checks
This cop checks whether the end keywords are aligned properly.
Three modes are supported through the EnforcedStyleAlignWith
configuration parameter:
If it's set to keyword
(which is the default), the end
shall be aligned with the start of the keyword (if, class, etc.).
If it's set to variable
the end
shall be aligned with the
left-hand-side of the variable assignment, if there is one.
If it's set to start_of_line
, the end
shall be aligned with the
start of the line where the matching keyword appears.
Example: EnforcedStyleAlignWith: keyword (default)
# bad
variable = if true
end
# good
variable = if true
end
Example: EnforcedStyleAlignWith: variable
# bad
variable = if true
end
# good
variable = if true
end
Example: EnforcedStyleAlignWith: startofline
# bad
variable = if true
end
# good
puts(if true
end)
Do not use ::
for method calls. Open
Unicode::normalize_KD('-' + string + '-').downcase.gsub('&', 'and').gsub(/[^a-z0-9\s_-]+/, '').gsub(/[\s_-]+/, '-')[0..-2]
- Read upRead up
- Exclude checks
This cop checks for methods invoked via the :: operator instead of the . operator (like FileUtils::rmdir instead of FileUtils.rmdir).
Example:
# bad
Timeout::timeout(500) { do_something }
FileUtils::rmdir(dir)
Marshal::dump(obj)
# good
Timeout.timeout(500) { do_something }
FileUtils.rmdir(dir)
Marshal.dump(obj)
Use the return of the conditional for variable assignment and comparison. Open
if at_start
string = demarkator + string
else
string = string.sub(/^#{demarkator}+/, '')
end
- Exclude checks
Use the return of the conditional for variable assignment and comparison. Open
if at_end
string = string + demarkator
else
string = string.sub(/#{demarkator}+$/, '')
end
- Exclude checks
Use self-assignment shorthand +=
. Open
string = string + demarkator
- Read upRead up
- Exclude checks
This cop enforces the use the shorthand for self-assignment.
Example:
# bad
x = x + 1
# good
x += 1